v1

latestSwagger 2.02026-07-179553242.0 KB
Execution

Get all balance-affecting executions.

get/execution/tradeHistory

Query parameters

targetAccountIdnumber double

AccountId fetching the trade history, must be a paired account with main user.

targetAccountIdsstring JSON

AccountIds fetching the trade history, must be a paired account with main user. Can be wildcard * to get all accounts linked to the authenticated user

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

execIDstring guid
orderIDstring guid
clOrdIDstring
clOrdLinkIDstring
accountinteger
symbolstring required
sidestring
lastQtyinteger
lastPxnumber double
lastLiquidityIndstring
orderQtyinteger
pricenumber double
displayQtyinteger
stopPxnumber double
pegOffsetValuenumber double
pegPriceTypestring
currencystring
settlCurrencystring
execTypestring
ordTypestring
timeInForcestring
execInststring
contingencyTypestring
ordStatusstring
triggeredstring
workingIndicatorboolean
ordRejReasonstring
leavesQtyinteger
cumQtyinteger
avgPxnumber double
commissionnumber double
feeTypestring
tradePublishIndicatorstring
textstring
trdMatchIDstring guid
execCostinteger
execComminteger
homeNotionalnumber double
foreignNotionalnumber double
transactTimestring date-time
timestampstring date-time required

Example response

[
  {
    "symbol": "symbol",
    "triggered": "triggered",
    "clOrdLinkID": "clOrdLinkID",
    "execInst": "execInst",
    "homeNotional": 1.4894159098541704,
    "pegOffsetValue": 9.301444243932576,
    "pegPriceType": "pegPriceType",
    "execID": "execID",
    "contingencyType": "contingencyType",
    "foreignNotional": 6.84685269835264,
    "execCost": 1,
    "execComm": 1,
    "settlCurrency": "settlCurrency",
    "ordRejReason": "ordRejReason",
    "price": 5.637376656633329,
    "trdMatchID": "trdMatchID",
    "orderQty": 5,
    "currency": "currency",
    "commission": 7.386281948385884,
    "text": "text",
    "execType": "execType",
    "timeInForce": "timeInForce",
    "timestamp": "2000-01-23T04:56:07.000+00:00",
    "ordStatus": "ordStatus",
    "side": "side",
    "orderID": "orderID",
    "lastPx": 1.4658129805029452,
    "leavesQty": 3,
    "cumQty": 2,
    "tradePublishIndicator": "tradePublishIndicator",
    "displayQty": 2,
    "feeType": "feeType",
    "clOrdID": "clOrdID",
    "lastQty": 6,
    "avgPx": 4.145608029883936,
    "workingIndicator": true,
    "lastLiquidityInd": "lastLiquidityInd",
    "transactTime": "2000-01-23T04:56:07.000+00:00",
    "account": 0,
    "stopPx": 7.061401241503109,
    "ordType": "ordType"
  }
]