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
| Parameter | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Trading 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
| Parameter | Type | Description |
|---|---|---|
| code | string | Response code |
| msg | string | Response message |
| requestTime | number | Request timestamp in milliseconds |
| data | object | Account data |
| > marginCoin | string | Margin coin (e.g., USDT) |
| > locked | string | Locked balance (used in orders) |
| > available | string | Available balance |
| > crossedMaxAvailable | string | Maximum available balance for cross margin mode |
| > isolatedMaxAvailable | string | Maximum available balance for isolated margin mode |
| > maxTransferOut | string | Maximum amount that can be transferred out |
| > accountEquity | string | Total account equity (available + locked + unrealizedPL) |
| > longLever | string | Leverage for long positions |
| > shortLever | string | Leverage for short positions |
| > marginMode | string | Margin mode: "isolated" or "crossed" |
| > unrealizedPL | string | Unrealized profit and loss |
| > coupon | string | Available 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
| Code | Message |
|---|---|
| 40034 | symbol does not exist |