Skip to main content

REST API Trading - Get SPOT order data

Get SPOT order data

Written by Albert
Updated today

Get SPOT order data

POST /frontoffice/api/v3/order-data

Summary

Use this method to retrieve and validate order data for SPOT market orders before placing.

Request

Header parameters

accountId required

The trading account identifier.

Body

order object

The order data.

order.marketId string

The market identifier, in the following format: {marketType}.{baseAssetId}_{quoteAssetId}, for example: spot.btc_usdt.

Must match one of the available markets returned by the Get markets endpoint.

order.side string

The order side, indicating the direction of the trade.

Possible values:

  • Buy

  • Sell

order.orderType string

The order type.

Possible values:

  • Market

  • Limit

order.requestedBaseAmount decimal string | nullable

The requested amount in base asset units.

order.requestedQuoteAmount decimal string | nullable

The requested amount in quote asset units.

order.requestedPrice decimal string | nullable

The limit price for Limit orders (the maximum price for a buy or minimum price for a sell).

Must be null or omitted for Market orders.

Request example

POST /frontoffice/api/v3/order-data HTTP/1.1
Host: {host}
Authorization: Bearer JWT
accountId: {accountId}
Content-Type: application/json; x-api-version=3.0
Accept: */*

{
"order": {
"marketId": "spot.eth_usdt",
"side": "Buy",
"orderType": "Limit",
"requestedBaseAmount": 0.2,
"requestedPrice": 4600
}
}

Response

In case of success, an object will be returned.

Each object contains the following information:

baseAmount decimal string

The calculated base asset amount for the order.

quoteAmount decimal string

The calculated quote asset amount for the order.

commissionAmount decimal string

The estimated commission amount to be charged.

total decimal string

The total quote asset amount, including the estimated commission.

Response example β€” 200: OK

{
"order": {
"baseAmount": "0.2",
"quoteAmount": "920",
"commissionAmount": "9.2",
"total": "929.2"
}
}

Did this answer your question?