Skip to main content

Account balance

GET 

/bot-gateway-service/api/v3/account

Retrieves current account information, including a list of assets along with their corresponding available and locked amounts.

Request

Query Parameters

    RecvWindow int64

    The number of milliseconds the request is valid for after the timestamp.

    • RecvWindow is optional.
    • The value cannot be greater than 60000.
    • If recvWindow is not sent, it defaults to 5000.
    Example: 60000

Responses

Success

Schema

    makerCommission int32

    Maker commission rate in percentage.

    takerCommission int32

    Taker commission rate in percentage.

    buyerCommission int32

    Buyer commission rate in percentage.

    sellerCommission int32

    Seller commission rate in percentage.

    commissionRates

    object

    maker stringnullable

    Maker commission rate in percentage (e.g., "0.00150000").

    taker stringnullable

    Taker commission rate in percentage (e.g., "0.00150000").

    buyer stringnullable

    Buyer commission rate in percentage (e.g., "0.00000000").

    seller stringnullable

    Seller commission rate in percentage (e.g., "0.00000000").

    canTrade boolean

    Indicates if trading is allowed.

    canWithdraw boolean

    Indicates if withdrawal is allowed.

    canDeposit boolean

    Indicates if a deposit is allowed.

    brokered boolean

    Indicates if the account is brokered.

    requireSelfTradePrevention boolean

    Indicates if self-trade prevention is required.

    preventSor boolean

    Indicates if SOR (Smart Order Routing) is prevented.

    updateTime int64

    The timestamp of the last update.

    accountType stringnullable

    The type of the account (e.g., SPOT).

    balances

    object[]

    nullable

    List of asset balances.

  • Array [

  • asset stringnullable

    The asset symbol (e.g., BTC).

    free stringnullable

    The amount of the asset that is free to trade.

    locked stringnullable

    The amount of the asset that is locked in trades or withdrawal requests.

  • ]

  • permissions string[]nullable

    List of permissions associated with the account (e.g., SPOT, MARGIN, LEVERAGED).

    uid int32

    Unique identifier for the account.

Loading...