Page cover

Get Account

requires auth

Account

Endpoint to retrieve account information, including current balances.

The different types of balances are:

Type
Description

free

Free balance available for credit free trading and withdraw

locked

Balances locked for pending withdrawals and orders

limit

The negative value of the account's credit limit. The free balance can drop to this value, but not below

pendingDeposit

The balance of deposits received but not yet credited to the account for trading

available

The balance that is available for trading. This is the free balance plus any available credit in the asset

GET /api/v1/accounting/account/{accountId}

Path Parameters:

Path
Type
Description

accountId*

string

your account ID

Example

GET /api/v1/accounting/account/NNCV3kWoo0Se_bUUl_8yRg
{
    "account": {
        "accountId": "NNCV3kWoo0Se_bUUl_8yRg",
        "type": "client",
        "name": "test-client-account",
        "balances": {
            "USD": {
                "free": 100.0,
                "locked": 0.0,
                "limit": -2000.0,
                "pendingDeposit": 0.0,
                "available": 2100.0
            },
            "USDT": {
                "free": 0.0,
                "locked": 0.0,
                "limit": -1000.0,
                "pendingDeposit": 0.0,
                "available": 1000.0
            },
            "BTC": {
                "free": 1.23,
                "locked": 0.0,
                "limit": 0.0,
                "pendingDeposit": 0.0,
                "available": 1.23
            }
        }
    },
    "status": "ok",
    "httpStatusCode": 200
}

Error response

Last updated