Skip to main content

Get Trade Balance

POST 

/private/TradeBalance

Retrieve a summary of collateral balances, margin position valuations, equity and margin level.

API Key Permissions Required: Orders and trades - Query open orders & trades

Request

Body

required
    nonce int64required

    Nonce used in construction of API-Sign header

    asset string

    Default value: ZUSD

    Base asset used to determine balance

Responses

Trade balances retrieved.

Schema
    result object

    Account Balance

    eb string

    Equivalent balance (combined balance of all currencies)

    tb string

    Trade balance (combined balance of all equity currencies)

    m string

    Margin amount of open positions

    n string

    Unrealized net profit/loss of open positions

    c string

    Cost basis of open positions

    v string

    Current floating valuation of open positions

    e string

    Equity: trade balance + unrealized net profit/loss

    mf string

    Free margin: Equity - initial margin (maximum margin available to open new positions)

    ml string

    Margin level: (equity / initial margin) * 100

    uv string

    Unexecuted value: Value of unfilled and partially filled orders

    error string[]
Loading...