Get Margin Account Summary
Returns complete summary of the authenticated user's margin account including balances, status, and risk metrics.
Endpoint URL
GET https://api.bitso.com/margin_trading/v1alpha/account
Request
This endpoint requires no request parameters.
Response
Fields
| Field | Type | Description |
|---|---|---|
status | string | Current status of the margin account. The status changes from INACTIVE to ACTIVE on deposit, to BLOCKED when the account is being liquidated, and back to INACTIVE when liquidation has ended or the user withdraws everything. Possible values: ACTIVE, INACTIVE, BLOCKED |
balances | array | List of currency balances held by the margin account |
margin_levels | object | Margin level thresholds information and current level |
margin_figures | object | Margin account financial figures including assets, liabilities and trading power |
Balance Object
| Field | Type | Description |
|---|---|---|
currency | string | Currency code |
net_amount | string | Net balance amount. Positive values represent net asset positions, negative values represent net liability positions |
Margin Levels Object
| Field | Type | Description |
|---|---|---|
current | string | Calculated margin level of the account ratio (total assets / total liabilities) |
safe | string | Safe margin level threshold for the account, orders can be created when current is above this level |
maintenance | string | Maintenance margin level threshold for the account, liquidation is executed when current is below this level |
Margin Figures Object
| Field | Type | Description |
|---|---|---|
currency | string | Currency in which the figures are expressed |
total_assets | string | Sum of all assets converted to the specified currency |
total_liabilities | string | Sum of all liabilities converted to the specified currency |
trading_power | string | Available trading power in the specified currency. This is the maximum amount that can be used to place orders while borrowing funds |
Payload Example
{
"status": "ACTIVE",
"margin_levels": {
"current": "2.5",
"safe": "1.5",
"maintenance": "1.1"
},
"margin_figures": {
"currency": "usd",
"total_assets": "10000.00",
"total_liabilities": "4000.00",
"trading_power": "5000.00"
},
"balances": [
{
"currency": "btc",
"net_amount": "0.50000000"
},
{
"currency": "usd",
"net_amount": "-1000.00"
}
]
}Updated about 20 hours ago
