Orders

GET Order

get
/v1/orders/{orderId}

Retrieve an order by its order ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
orderIdstringRequired
Responses
chevron-right
200

Successful response

application/json
orderIdstring · uuidOptional
accountIdstring · uuidOptional
orderStatusstring · enumOptionalPossible values:
sidestringOptionalExample: BUY
pairstringOptionalExample: BTC-USD
strategystring · enumOptionalPossible values:
limitPricestring · numberOptionalExample: 52100.00
orderPricestring · numberOptionalExample: 52100.00
leavesQtystring · numberOptional

Remaining quantity to be filled

Example: 1.00
orderQuantitystring · numberOptionalExample: 1.00
fillQuantitystring · numberOptionalExample: 1.00
cumulativeQtystring · numberOptional

Only exists for MARKET/LIMIT orders

Example: 1.00
fillPricestring · numberOptionalExample: 52100.00
avgPricestring · numberOptional

Only exists for MARKET/LIMIT orders

Example: 52100.00
orderTypestring · enumOptionalPossible values:
timeInForcestring · enumOptional

Time in force should be DAY for market orders

Example: DAYPossible values:
expireTimestring · date-time · nullableOptional

Only exists for LIMIT orders

Example: 2025-05-31T23:59:59.000Z
clientOrderIdstring · uuid · nullableOptionalExample: 5f80d325-0f71-4f0a-a346-75c7bb6ac867
fillPercentagestring · numberOptionalExample: 100
clientFeeRatestring · integerOptionalExample: 10
providerFeeRatestring · integerOptionalExample: 10
placedAtstring · date-timeOptional
completedAtstring · date-time · nullableOptional
clientReferencestring · nullableOptional
rejectedAtstring · date-time · nullableOptional

Only exists for REJECTED orders

orderRejectReasonstring · nullableOptional

Only exists for REJECTED orders

currencystringOptionalExample: BTC
get
/v1/orders/{orderId}

GET Orders

get
/v1/orders

Retrieve a list of orders with optional filtering and pagination.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
clientReferencestringOptional

Filter orders by client provided reference parameter

orderStatusstring · enumOptional

Filter orders by order status

Possible values:
placedAtStartstring · date-timeOptional

Filter orders by when the order was placed. Lower bound, exclusive

placedAtEndstring · date-timeOptional

Filter orders by when the order was placed. Upper bound, inclusive

completedAtStartstring · date-timeOptional

Filter orders by when the order was completely filled. Lower bound, exclusive

completedAtEndstring · date-timeOptional

Filter orders by when the order was completely filled. Upper bound, inclusive

accountIdstring · uuidOptional

Filter orders by account ID

pairstringOptional

Filter orders by pair

Example: BTC-USD
sidestringOptional

Filter orders by side

Example: BUY
afterstringOptional

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring · integerOptional

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

sortFieldstring · enumOptional

Will sort the returned data using the specified field.

Possible values:
sortDirectionstring · enumOptional

Specifies the sort direction for the sortField.

Possible values:
Responses
chevron-right
200

Successful response

application/json
afterstring · nullableOptional

The token of the last item in the response

totalCountstring · integerOptional

The total number of items in the entire filtered data set

Example: 1
get
/v1/orders

Execute a Quote (RFQ)

post
/v1/orders

Execute a previously requested quote. Creates an Order and Executes it. Retuns both the order and the execution.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
quoteIdstring · uuidRequired

The quoteId returned by Request Quote

clientReferencestringOptional
Responses
chevron-right
200

Successful response

application/json
post
/v1/orders

Create Order

post
/v1/orders

For orders to be accepted, the account must have sufficient buying power. Once placed, an amount equivalent to the maximum potential value of the order will be reserved from the account balance for the duration that the order remains open.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
x-request-Idstring · uuidOptional

A unique 'Transaction Reference Number for each incoming trade execution request. Any retries will retain the same x-request-Id value.

Body
or
or
Responses
chevron-right
200

Successful response

application/json
Responseone of
or
post
/v1/orders

Cancel an Order (WIP)

delete
/v1/orders/{orderId}

Cancel a LIMIT order in NEW status

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
orderIdstringRequired
Responses
chevron-right
200

OK

application/json
orderIdstringRequiredExample: 876818f4-e054-49ec-a2de-313f9fc96b92
orderStatusstring · enumRequiredPossible values:
delete
/v1/orders/{orderId}

Last updated