API Reference
- GETTest Connectivity
- GETCheck Server Time
- GETContracts List
- GETDepth
- GET24Hrs Ticker
- GETObtain Index/Tag Price
- GETKline/Candlestick Data
- GETOrder Information
- POSTCreate New Order
- POSTCreate New Condition Order
- POSTCancel Order
- GETCurrent Open Orders
- POSTHistorical Commission Records
- POSTProfit And Loss Records
- GETTransaction Records
- POSTChange Position Model
- POSTChange Margin Model
- POSTChange Leverage
- POSTObtain The Current Trigger Order
- POSTCancel Trigger Order
- GETAccount Information
API Reference
Account Information
Get account information.
GET
/
fapi
/
v1
/
account
curl --request GET \
--url https://futuresopenapi.odyssey.trade/fapi/v1/account \
--header 'x-ch-apikey: <x-ch-apikey>' \
--header 'x-ch-sign: <x-ch-sign>' \
--header 'x-ch-ts: <x-ch-ts>'
{
"account": [
{
"marginCoin": "<string>",
"accountNormal": "<string>",
"accountLock": "<string>",
"partPositionNormal": "<string>",
"totalPositionNormal": "<string>",
"achievedAmount": "<string>",
"unrealizedAmount": "<string>",
"totalMarginRate": "<string>",
"totalEquity": "<string>",
"partEquity": "<string>",
"totalCost": "<string>",
"sumMarginRate": "<string>",
"positionVos": [
{
"contractId": 123,
"contractName": "<string>",
"contractOtherName": "<string>",
"contractSymbol": "<string>",
"positions": [
{
"id": 123,
"uid": 123,
"contractId": 123,
"positionType": 1,
"side": "BUY",
"volume": "<string>",
"openPrice": "<string>",
"avgPrice": "<string>",
"closePrice": "<string>",
"leverageLevel": 123,
"openAmount": "<string>",
"holdAmount": "<string>",
"closeVolume": "<string>",
"pendingCloseVolume": "<string>",
"realizedAmount": "<string>",
"historyRealizedAmount": "<string>",
"tradeFee": "<string>",
"capitalFee": "<string>",
"closeProfit": "<string>",
"shareAmount": "<string>",
"freezeLock": 0,
"status": 0,
"ctime": "2023-11-07T05:31:56Z",
"mtime": "2023-11-07T05:31:56Z",
"brokerId": 123,
"lockTime": "2023-11-07T05:31:56Z",
"marginRate": "<string>",
"reducePrice": "<string>",
"returnRate": "<string>",
"unRealizedAmount": "<string>",
"openRealizedAmount": "<string>",
"positionBalance": "<string>",
"settleProfit": "<string>",
"indexPrice": "<string>",
"keepRate": "<string>",
"maxFeeRate": "<string>"
}
]
}
]
}
]
}
Headers
Request signature.
The user's API key.
The current time in milliseconds.
Response
200
application/json
Successful Response
An object with information about requested account.
curl --request GET \
--url https://futuresopenapi.odyssey.trade/fapi/v1/account \
--header 'x-ch-apikey: <x-ch-apikey>' \
--header 'x-ch-sign: <x-ch-sign>' \
--header 'x-ch-ts: <x-ch-ts>'
{
"account": [
{
"marginCoin": "<string>",
"accountNormal": "<string>",
"accountLock": "<string>",
"partPositionNormal": "<string>",
"totalPositionNormal": "<string>",
"achievedAmount": "<string>",
"unrealizedAmount": "<string>",
"totalMarginRate": "<string>",
"totalEquity": "<string>",
"partEquity": "<string>",
"totalCost": "<string>",
"sumMarginRate": "<string>",
"positionVos": [
{
"contractId": 123,
"contractName": "<string>",
"contractOtherName": "<string>",
"contractSymbol": "<string>",
"positions": [
{
"id": 123,
"uid": 123,
"contractId": 123,
"positionType": 1,
"side": "BUY",
"volume": "<string>",
"openPrice": "<string>",
"avgPrice": "<string>",
"closePrice": "<string>",
"leverageLevel": 123,
"openAmount": "<string>",
"holdAmount": "<string>",
"closeVolume": "<string>",
"pendingCloseVolume": "<string>",
"realizedAmount": "<string>",
"historyRealizedAmount": "<string>",
"tradeFee": "<string>",
"capitalFee": "<string>",
"closeProfit": "<string>",
"shareAmount": "<string>",
"freezeLock": 0,
"status": 0,
"ctime": "2023-11-07T05:31:56Z",
"mtime": "2023-11-07T05:31:56Z",
"brokerId": 123,
"lockTime": "2023-11-07T05:31:56Z",
"marginRate": "<string>",
"reducePrice": "<string>",
"returnRate": "<string>",
"unRealizedAmount": "<string>",
"openRealizedAmount": "<string>",
"positionBalance": "<string>",
"settleProfit": "<string>",
"indexPrice": "<string>",
"keepRate": "<string>",
"maxFeeRate": "<string>"
}
]
}
]
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.