For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get account info

This endpoint allows users to get all high-level account info such as balance, fee level, equity, etc.

GET /api/v1/account

Query Parameters

Field
Type
Need
Description
Example

"account"

string

required

Account address

42trU9A5...

/api/v1/account?account=42trU9A5...

Response

  • Status 200: Successfully retrieved account information

{
  "success": true,
  "data": {
    "balance": "2000.000000",
    "fee_level": 0,
    "maker_fee": "0.00015",
    "taker_fee": "0.0004",
    "account_equity": "2150.250000",
    "available_to_spend": "1800.750000",
    "available_to_withdraw": "1500.850000",
    "pending_balance": "0.000000",
    "pending_interest": "0.000000",
    "spot_collateral": "0.000000",
    "cross_account_equity": "2100.500000",
    "spot_market_value": "250.000000",
    "total_margin_used": "349.500000",
    "cross_mmr": "420.690000",
    "positions_count": 2,
    "orders_count": 3,
    "stop_orders_count": 1,
    "updated_at": 1716200000000,
    "spot_balances": [
      {
        "symbol": "SOL",
        "amount": "1.50000000",
        "available_to_withdraw": "1.00000000",
        "pending_balance": "0.50000000",
        "daily_withdraw_amount_usd": "250.000000",
        "effective_daily_deposit_limit_usd": "50000.000000",
        "effective_daily_withdraw_limit_usd": "250000.000000"
      }
    ]
  },
  "error": null,
  "code": null
}
Field
Type
Description

'balance'

decimal string

Current account balance, defined as amount of USD in account before settlement

'fee_level'

integer

Current fee tier of account, determined by trading volume

'maker_fee'

decimal string

Current maker fee rate of account, determined by trading volume

'taker_fee'

decimal string

Current taker fee rate of account, determined by trading volume

'account_equity'

decimal string

Account balance + unrealized PnL + isolated margin + raw spot market value

'available_to_spend'

decimal string

Amount of account equity that is available to used to margin for open positions and orders

'available_to_withdraw'

decimal string

Amount that is available to withdraw out from the exchange

'pending_balance'

decimal string

Amount of account balance in pending status (deposit request is successful, waiting on confirmation)

'total_margin_used'

decimal string

Amount of account equity currently being used to margin for open positions and orders

'cross_mmr'

decimal string

The maintenance margin required under the cross mode

'positions_count'

integer

Number of open positions (isolated and cross)

'orders_count'

integer

Number of open orders across all markets (excludes stop orders)

'stop_orders_count'

integer

Number of open stop orders across markets

'pending_interest'

decimal string

Accrued loan interest not yet repaid

'spot_collateral'

decimal string

Total USD value of spot assets used as collateral for unified margin

'cross_account_equity'

decimal string or null

Cross-margin equity after applying unified-margin collateral rules. null if not applicable

'spot_market_value'

decimal string

Raw marked-to-market value of positive spot balances before collateral haircuts

'spot_balances'

array

List of spot asset balances held by the account (see below)

'updated_at'

integer

Timestamp in milliseconds of last account info update

Spot Balance Fields

Field
Type
Description

'symbol'

string

Spot asset symbol

'amount'

decimal string

Total amount of the spot asset held

'available_to_withdraw'

decimal string

Amount available to withdraw

'pending_balance'

decimal string

Amount pending confirmation

'daily_withdraw_amount_usd'

decimal string

USD value of withdrawals made today

'effective_daily_deposit_limit_usd'

decimal string

Daily deposit limit in USD

'effective_daily_withdraw_limit_usd'

decimal string

Daily withdrawal limit in USD

  • Status 400: Invalid request parameters

  • Status 401: Unauthorized access

  • Status 500: Internal server error

Code Example (Python)

Last updated