Query executed order history

Retrieve the history of fully and partially executed spot orders via the WhiteBIT V4 API.

POST /api/v4/trade-account/executed-history

Query executed order history

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/trade-account/executed-history \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "market": "BTC_USDT",
  "client_order_id": "customId11",
  "startDate": 1593233939,
  "endDate": 1593233939,
  "offset": 0,
  "limit": 50,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

200

[
  {
    "id": 123,
    "client_order_id": "<string>",
    "time": 123,
    "side": "buy",
    "role": 123,
    "amount": "<string>",
    "price": "<string>",
    "deal": "<string>",
    "fee": "<string>",
    "order_id": 123,
    "feeAsset": "<string>"
  }
]

Authorizations

X-TXC-APIKEY · string · header · required

The public WhiteBIT API key.

X-TXC-PAYLOAD · string · header · required

Base64-encoded JSON request body.

X-TXC-SIGNATURE · string · header · required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

Body

application/json

market · string

Requested market. Example: BTC_USDT

Example:

"BTC_USDT"

client_order_id · string

Filter by custom order identifier

Example:

"customId11"

startDate · integer

Start date in Unix-time format

Example:

1593233939

endDate · integer

End date in Unix-time format

Example:

1593233939

offset · integer · default: 0

Starting line index (OFFSET). Default: 0, Min: 0

Example:

0

limit · integer · default: 50

LIMIT is a special clause used to limit records a particular query can return. Default: 50, Min: 1, Max: 500

Required range: 1 <= x <= 500

Example:

50

request · string

Example:

"{{request}}"

nonce · string

Example:

"{{nonce}}"

Response

200

application/json

Executed order history. Response shape depends on whether the market filter is provided: with market filter returns a flat array; without market filter returns an object keyed by market name.

object[]

object

id · integer

Unique deal identifier assigned by the matching engine.

client_order_id · string

Custom order identifier supplied in the original order request. Returns an empty string when not specified.

time · number

Unix timestamp of the deal execution, with microsecond precision.

side · enum<string>

Order side that produced the deal. Possible values: buy, sell.

Available options: buy, sell

role · integer

Execution role in the deal. 1 = maker (order was resting on the book), 2 = taker (order matched immediately).

amount · string

Executed quantity in base (stock) currency, regardless of order direction.

price · string

Execution price per unit in quote currency.

deal · string

Total deal value in quote (money) currency. Equals amount * price.

fee · string

Fee charged for the deal, denominated in the asset specified by feeAsset.

order_id · integer

Identifier of the parent order that produced the deal.

feeAsset · string

Currency ticker of the asset used to pay the trading fee.