Futures Account API

danger

Poloniex futures v1/v2 API will be officially offline on November 30, 2024. You can access the V3 API to provide you with a better trading experience.

Get Account Overview

HTTP Request

GET https://futures-api.poloniex.com/api/v1/account-overview

Example

GET https://futures-api.poloniex.com/api/v1/account-overview?currency=USDT

Parameters

Param	Type	Description
currency	String	[Optional] Currency, XBT or USDT, Default USDT

API Permission

This endpoint requires the General permission.

REQUEST RATE LIMIT

This API is restricted for each account, the request rate limit is 3 times/3s.

Example:

{
    "code": "200000",
    "data": {
        "accountEquity": 99.8999305281, //Account equity = marginBalance + Unrealised PNL
        "unrealisedPNL": 0, //Unrealised profit and loss
        "marginBalance": 99.8999305281, //Margin balance = positionMargin + orderMargin + frozenFunds + availableBalance
        "positionMargin": 0, //Position margin
        "orderMargin": 0, //Order margin
        "frozenFunds": 0, //Frozen funds
        "availableBalance": 99.8999305281 //Available balance
        "currency": "USDT", //currency code
        "pnl":-1 //Realised profit and loss
    }
}

Get Transaction History

If there are open positions, the status of the first page returned will be Pending, indicating the realized profit and loss in the current 8-hour settlement period. Please specify the minimum offset number of the current page into the offset field to turn the page.

HTTP Request

GET https://futures-api.poloniex.com/api/v1/transaction-history

Example

GET https://futures-api.poloniex.com/api/v1/transaction-history?offset=1&forward=true&maxCount=50

API Permission

This endpoint requires the General permission.

REQUEST RATE LIMIT

This API is restricted for each account, the request rate limit is 9 times/3s.

Parameters

Param	Type	Description
startAt	long	[Optional] Start time (millisecond)
endAt	long	[Optional] End time (millisecond)
type	String	[Optional] Type RealisedPNL-Realised profit and loss, Transferin-Transfer in, TransferOut-Transfer out
offset	long	[Optional] Start offset
maxCount	long	[Optional] Displayed size per page. The default size is 50
currency	String	[Optional] Currency of transaction history XBT or USDT

Returned Data Types

Field	Description
type	RealisedPNL, Deposit, TransferIn, TransferOut
status	Completed, Pending

Example:

{
    "code": "200000",
    "data": {
        "hasMore": false, //Whether there are more pages
        "dataList": [
            {
                "ts": 1558596284040, //Event time
                "type": "RealisedPNL", //Type
                "amount": 0, //Transaction amount
                "fee": null, //Fees
                "accountEquity": 8060.7899305281, //Account equity
                "status": "Pending", //Status. If you have held a position in the current 8-hour settlement period.
                "remark": "BTCUSDTPERP", //Ticker symbol of the contract
                "offset": -1, //Offset
                "currency": "XBT" //Currency
            },
            {
                "ts": 1557997200000,
                "type": "RealisedPNL",
                "amount": -0.000017105,
                "fee": 0,
                "accountEquity": 8060.7899305281,
                "status": "Completed", //Status. Status. Funding period that has been settled.
                "remark": "BTCUSDTPERP",
                "offset": 1,
                "currency": "XBT"
            }
        ]
    }
}