v1

latestSwagger 2.02026-07-179553242.0 KB

Order

Get your orders.

To get open orders only, send {"open": true} in the filter param.

See <a href="http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_D_68.html">the FIX Spec</a> for explanations of these fields.

get/order

Query parameters

symbolstring

Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

You can also send a timeframe, e.g. XBT:quarterly. Timeframes are nearest, daily, weekly, monthly, quarterly, biquarterly, and perpetual.

Symbols are case-insensitive.

filterstring JSON

Generic table filter. Send JSON key/value pairs, such as {"key": "value"}. You can key on individual fields, and do more advanced querying on timestamps. See the Timestamp Docs for more details.

columnsstring JSON

Array of column names to fetch. If omitted, will return all columns.

Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.

countinteger

Number of results to fetch. Must be a positive integer.

startinteger

Starting point for results.

reverseboolean

If true, will sort results newest first.

startTimestring date-time

Starting date filter for results.

endTimestring date-time

Ending date filter for results.

Response

Request was successful

orderIDstring guid required

clOrdIDstring

clOrdLinkIDstring

accountinteger

symbolstring

sidestring

orderQtyinteger

pricenumber double

displayQtyinteger

stopPxnumber double

pegOffsetValuenumber double

pegPriceTypestring

currencystring

settlCurrencystring

ordTypestring

timeInForcestring

execInststring

contingencyTypestring

ordStatusstring

triggeredstring

workingIndicatorboolean

ordRejReasonstring

leavesQtyinteger

cumQtyinteger

avgPxnumber double

textstring

transactTimestring date-time

timestampstring date-time

Example response

[
  {
    "symbol": "symbol",
    "triggered": "triggered",
    "clOrdLinkID": "clOrdLinkID",
    "execInst": "execInst",
    "pegOffsetValue": 2.3021358869347655,
    "pegPriceType": "pegPriceType",
    "contingencyType": "contingencyType",
    "settlCurrency": "settlCurrency",
    "ordRejReason": "ordRejReason",
    "price": 1.4658129805029452,
    "orderQty": 6,
    "currency": "currency",
    "text": "text",
    "timeInForce": "timeInForce",
    "timestamp": "2000-01-23T04:56:07.000+00:00",
    "ordStatus": "ordStatus",
    "side": "side",
    "orderID": "orderID",
    "leavesQty": 7,
    "cumQty": 9,
    "displayQty": 5,
    "clOrdID": "clOrdID",
    "avgPx": 3.616076749251911,
    "workingIndicator": true,
    "transactTime": "2000-01-23T04:56:07.000+00:00",
    "account": 0,
    "stopPx": 5.637376656633329,
    "ordType": "ordType"
  }
]