Executions

GET Execution

Retrieve specific fill by execution ID.

GEThttp://localhost:3001/api/v1/executions/{executionId}

Path parameters

executionId*string (uuid)

The execution ID returned by the executeQuote endpoint

Response

2004004014034XX5XX

Successful response

Body

application/json

executionIdstring (uuid)

orderIdstring (uuid)

accountIdstring (uuid)

executedAtstring (date-time)

pairstring

Example: "BTC-USD"

sidestring

Example: "BUY"

deliverCurrencystring

Example: "BTC"

deliverQuantitystring

Example: "1.00"

receiveCurrencystring

Example: "USD"

receiveQuantitystring

Example: "52100.00"

pricestring (number)

Example: "52100.00"

baseQuantitystring (number)

Example: "0.0016"

quoteQuantitystring (number)

Example: "10.74"

clientFeeRatestring (integer)

Example: "10"

providerFeeRatestring (integer)

Example: "10"

clientFeeQuantitystring (number)

Example: "52.10"

providerFeeQuantitystring (number)

Example: "52.10"

feeCurrencystring

Example: "USD"

executionStatusExecutionStatus (enum)

TRADE_EXECUTEDTRADE_CONFIRMEDTRADE_SETTLED

tradeDatestring (date)

valueDatestring (date)

confirmedAtnullable string (date-time)

clientReferencenullable string

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/executions/{executionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "executionId": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "executedAt": "2024-10-16T00:20:40.876Z",
  "pair": "BTC-USD",
  "side": "BUY",
  "deliverCurrency": "BTC",
  "deliverQuantity": "1.00",
  "receiveCurrency": "USD",
  "receiveQuantity": "52100.00",
  "price": "52100.00",
  "baseQuantity": "0.0016",
  "quoteQuantity": "10.74",
  "clientFeeRate": "10",
  "providerFeeRate": "10",
  "clientFeeQuantity": "52.10",
  "providerFeeQuantity": "52.10",
  "feeCurrency": "USD",
  "executionStatus": "TRADE_EXECUTED",
  "tradeDate": "2024-10-16",
  "valueDate": "2024-10-16",
  "confirmedAt": "2024-10-16T00:20:40.876Z",
  "clientReference": "text"
}

GET Executions

Retrieve fills with optional filtering and pagination.

GEThttp://localhost:3001/api/v1/executions

Query parameters

Response

2004004014034XX5XX

Successful response

Body

application/json

afternullable string

The token of the last item in the response

totalCountstring (integer)

The total number of items in the entire filtered data set

Example: "1"

itemsarray of Execution

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/executions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "executionId": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "executedAt": "2024-10-16T00:20:40.876Z",
      "pair": "BTC-USD",
      "side": "BUY",
      "deliverCurrency": "BTC",
      "deliverQuantity": "1.00",
      "receiveCurrency": "USD",
      "receiveQuantity": "52100.00",
      "price": "52100.00",
      "baseQuantity": "0.0016",
      "quoteQuantity": "10.74",
      "clientFeeRate": "10",
      "providerFeeRate": "10",
      "clientFeeQuantity": "52.10",
      "providerFeeQuantity": "52.10",
      "feeCurrency": "USD",
      "executionStatus": "TRADE_EXECUTED",
      "tradeDate": "2024-10-16",
      "valueDate": "2024-10-16",
      "confirmedAt": "2024-10-16T00:20:40.876Z",
      "clientReference": "text"
    }
  ]
}