Skip to main content

Get Account

Get account balance and margin information for a specific trading symbol, including available balance, locked balance, leverage settings, and unrealized PnL.

HTTP Request

GET /api/v1/future/account

Request Parameters

ParameterTypeRequiredDescription
symbolstringYesTrading pair symbol (e.g., BTCUSDT)

Request Example

curl -X GET "https://open-api.bydoxe.com/api/v1/future/account?symbol=BTCUSDT" \
-H "ACCESS-KEY: your-api-key" \
-H "ACCESS-SIGN: your-signature" \
-H "ACCESS-PASSPHRASE: your-passphrase" \
-H "ACCESS-TIMESTAMP: 1659076670000"

Response Parameters

ParameterTypeDescription
codestringResponse code
msgstringResponse message
requestTimenumberRequest timestamp in milliseconds
dataobjectAccount data
> marginCoinstringMargin coin (e.g., USDT)
> lockedstringLocked balance (used in orders)
> availablestringAvailable balance
> crossedMaxAvailablestringMaximum available balance for cross margin mode
> isolatedMaxAvailablestringMaximum available balance for isolated margin mode
> maxTransferOutstringMaximum amount that can be transferred out
> accountEquitystringTotal account equity (available + locked + unrealizedPL)
> longLeverstringLeverage for long positions
> shortLeverstringLeverage for short positions
> marginModestringMargin mode: "isolated" or "crossed"
> unrealizedPLstringUnrealized profit and loss
> couponstringAvailable coupon balance

Response Example

Success Response

{
"code": "00000",
"msg": "success",
"requestTime": 1732000000000,
"data": {
"marginCoin": "USDT",
"locked": "4500.00",
"available": "15500.00",
"crossedMaxAvailable": "15500.00",
"isolatedMaxAvailable": "15500.00",
"maxTransferOut": "15000.00",
"accountEquity": "20500.00",
"longLever": "10",
"shortLever": "10",
"marginMode": "isolated",
"unrealizedPL": "500.00",
"coupon": "100.00"
}
}

Error Codes

CodeMessage
40034symbol does not exist