Account Endpoints
- Path: /api/v1/account/balance
- Method: GET
- Description: Query account information
- Parameters:
- Response:
├─ code: Number
├─ msg: String
└─ data: Object
├─ totalWalletBalance: String (total wallet balance, only for USDT asset)
├─ totalUnrealizedProfit: String (total unrealized profit, only for USDT asset)
├─ totalMarginBalance: String (total margin balance, only for USDT asset)
├─ totalPositionMargin: String (initial margin required for positions with current mark price, only for USDT asset)
├─ totalFrozenMargin: String (initial margin required for open orders with current mark price, only for USDT asset)
├─ totalFrozenMoney: String (total frozen money, only for USDT asset)
├─ totalAvailableBalance: String (available balance, only for USDT asset)
└─ assets: Array
├─ asset: String
├─ walletBalance: String (wallet balance)
├─ unrealizedProfit: String (unrealized profit)
├─ marginBalance: String (margin balance)
├─ positionMargin: String (total initial margin required with current mark price)
├─ frozenMargin: String (initial margin required for open orders with current mark price)
├─ frozenMoney: String (frozen money)
├─ availableBalance: String (available balance)
└─ updateTime: Number
- Example:
Request:
https://api.aboard.exchange/arbitrum/api/v1/account/balance
Response:
{
"code": 0,
"msg": "",
"data": {
"totalWalletBalance": "23.72469206",
"totalUnrealizedProfit": "0.00000000",
"totalMarginBalance": "23.72469206",
"totalPositionMargin": "0.00000000",
"totalFrozenMargin": "0.00000000",
"totalFrozenMoney": "0.00000000",
"totalAvailableBalance": "23.72469206",
"assets": [
{
"asset": "USDT",
"walletBalance": "23.72469206",
"unrealizedProfit": "0.00000000",
"marginBalance": "23.72469206",
"positionMargin": "0.00000000",
"frozenMargin": "0.00000000",
"frozenMoney": "0.00000000",
"availableBalance": "23.72469206",
"updateTime": 1625474304765
}
]
}
}
- Path: /api/v1/account/positions
- Method: GET
- Description: Query position
- Parameters:
└─ symbol: String
- Response:
├─ code: Number
├─ msg: String
└─ data: Array
├─ symbol: String
├─ positionSide: String
├─ marginType: String (margin mode:ISOLATED/CROSSED)
├─ positionAmt: String (Position quantity. The symbol represents the long and short direction. Positive numbers are many and negative numbers are empty)
├─ availableAmt: String (Open position quantity)
├─ leverage: String
├─ openPrice: String
├─ unRealizedProfit: String (Unrealized profits and losses of positions)
├─ positionMargin: String (Position margin)
├─ isAutoAddMargin: String (If increase margin when Isolated)
├─ isolatedMargin: String (Isolated margin)
├─ markPrice: String (Mark price)
├─ liquidationPrice: String (Liquidation price)
├─ marginRate: String (Margin rate)
└─ updateTime: Number
- Example:
Request:
https://api.aboard.exchange/arbitrum/api/v1/account/positions?symbol=ETH-USDC
Response:
{
"code": 0,
"msg": "",
"data": [
{
"symbol": "ETH-USDC",
"positionSide": "NET",
"marginType": "CROSSED",
"positionAmt": "-234.78",
"availableAmt": "200",
"leverage": "10",
"openPrice": "0.00000",
"unRealizedProfit": "0.00",
"positionMargin": "0.00",
"isAutoAddMargin": "false",
"isolatedMargin": "0.00",
"markPrice": "6679.50671178",
"liquidationPrice": "0",
"marginRate": "0",
"updateTime": 1625474304765
}
]
}
- Path: /api/v1/account/bills
- Method: GET
- Description: Get income history
- Parameters:
├─ symbol: String
├─ billType: String (DEPOSIT, WITHDRAW, REALIZED_PNL,FUNDING_FEE, COMMISSION, LIQUIDATION)
├─ startTime: Number
├─ endTime: Number