Skip to main content

Query Orders Info

POST 
/private/QueryOrders

Retrieve information about specific orders.

API Key Permissions Required: Orders and trades - Query open orders & trades or Orders and trades - Query closed orders & trades, depending on status of order

Request​

Body

required
    nonce int64required

    Nonce used in construction of API-Sign header

    trades boolean

    Whether or not to include trades related to position in output

    userref int32

    Restrict results to given user reference id

    txid stringrequired

    Comma delimited list of transaction IDs to query info about (50 maximum)

    consolidate_taker boolean

    Default value: true

    Whether or not to consolidate trades by individual taker trades

Responses​

Orders info retrieved.

Schema
    result object

    txid of the order.

    oneOf
    refid stringnullable

    Referral order transaction ID that created this order

    userref integernullable

    Optional numeric, client identifier associated with one or more orders.

    cl_ord_id stringnullable

    Optional alphanumeric, client identifier associated with the order.

    status string

    Possible values: [pending, open, closed, canceled, expired]

    Status of order

    • pending = order pending book entry
    • open = open order
    • closed = closed order
    • canceled = order canceled
    • expired = order expired
    opentm number

    Unix timestamp of when order was placed

    starttm number

    Unix timestamp of order start time (or 0 if not set)

    expiretm number

    Unix timestamp of order end time (or 0 if not set)

    descr object

    Order description info

    pair string

    Asset pair

    type string

    Possible values: [buy, sell]

    Type of order (buy/sell)

    ordertype ordertype (string)

    Possible values: [market, limit, iceberg, stop-loss, take-profit, stop-loss-limit, take-profit-limit, trailing-stop, trailing-stop-limit, settle-position]

    Order type

    price string

    primary price

    price2 string

    Secondary price

    leverage string

    Amount of leverage

    order string

    Order description

    close string

    Conditional close order description (if conditional close set)

    vol string

    Volume of order (base currency)

    vol_exec string

    Volume executed (base currency)

    cost string

    Total cost (quote currency unless)

    fee string

    Total fee (quote currency)

    price string

    Average price (quote currency)

    stopprice string

    Stop price (quote currency)

    limitprice string

    Triggered limit price (quote currency, when limit based order type triggered)

    trigger string

    Possible values: [last, index]

    Default value: last

    Price signal used to trigger "stop-loss" "take-profit" "stop-loss-limit" "take-profit-limit" orders.

    • last is the implied trigger if this field is not set.
    margin boolean

    Indicates if the order is funded on margin.

    misc string

    Comma delimited list of miscellaneous info

    • stopped triggered by stop price
    • touched triggered by touch price
    • liquidated liquidation
    • partial partial fill
    • amended order parameters modified
    sender_sub_id stringnullable

    For institutional accounts, identifies underlying sub-account/trader for Self Trade Prevention (STP).

    oflags oflags (string)

    Comma delimited list of order flags

    • • post post-only order (available when ordertype = limit)
    • • fcib prefer fee in base currency (default if selling)
    • • fciq prefer fee in quote currency (default if buying, mutually exclusive with fcib)
    • • nompp disable market price protection for market orders
    • • viqc order volume expressed in quote currency. This option is supported only for buy market orders. Also not available on margin orders.
    trades string[]

    List of trade IDs related to order (if trades info requested and data available)

    error string[]
Loading...