Skip to main content

Get Open Positions

POST 
/private/OpenPositions

Get information about open margin positions.

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

Request​

Body

required
    nonce int64required

    Nonce used in construction of API-Sign header

    txid string

    Comma delimited list of txids to limit output to

    docalcs boolean

    Whether to include P&L calculations

    consolidation string

    Possible values: [market]

    Consolidate positions by market/pair

Responses​

Open positions info retrieved.

Schema
    result object
    property name* txid
    ordertxid string

    Order ID responsible for the position

    posstatus string

    Possible values: [open]

    Position status

    pair string

    Asset pair

    time number

    Unix timestamp of trade

    type string

    Direction (buy/sell) of position

    ordertype string

    Order type used to open position

    cost string

    Opening cost of position (in quote currency)

    fee string

    Opening fee of position (in quote currency)

    vol string

    Position opening size (in base currency)

    vol_closed string

    Quantity closed (in base currency)

    margin string

    Initial margin consumed (in quote currency)

    value string

    Current value of remaining position (if docalcs requested)

    net string

    Unrealised P&L of remaining position (if docalcs requested)

    terms string

    Funding cost and term of position

    rollovertm string

    Timestamp of next margin rollover fee

    misc string

    Comma delimited list of add'l info

    oflags string

    Comma delimited list of opening order flags

    error string[]
Loading...