On this page

# 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

    {
      "data": {
        "balance": "2000.000000",
        "fee_level": 0,
        "account_equity": "2150.250000",
        "available_to_spend": "1800.750000",
        "pending_balance": "0.000000",
        "total_margin_used": "349.500000",
        "positions_count": 2,
        "orders_count": 3,
        "stop_orders_count": 1,
        "updated_at": 1716200000000
      },
      "error": null,
      "code": null
    }

Field
Type
Description

`'balance'`

decimal string

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

`'fee_level'`

decimal string

Current fee tier of account, determined by trading volume

`'account_equity'`

decimal string

Account balance + unrealized PnL

`'available_to_spend'`

decimal string

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

`'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

`'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

`'updated_at'`

integer

Timestamp in milliseconds of last account info update

- Status 400: Invalid request parameters

- Status 401: Unauthorized access

- Status 500: Internal server error

####
Code Example (Python)

    import requests

    response = requests.get(
        "/api/v1/account?account=42trU9A5...",
        headers={"Accept": "*/*"},
    )

    data = response.json()

Previous Account
Next Get account settings

Last updated 3 months ago