Skip to main content
Query executed orders

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

Trading pair to filter by. Format: BASE_QUOTE (e.g., BTC_USDT). Omit to retrieve orders across all markets.

Example:

"BTC_USDT"

clientOrderId
string

Look up a specific order by the custom client identifier. When supplied, the endpoint switches to single-order lookup mode and the startDate, endDate, and status filters are ignored. Returns 422 with "OrderHistory was not found." if no order matches. Ignored when orderId is also provided.

Example:

"customId11"

orderId
integer

Look up a specific order by the exchange-assigned identifier. When supplied, the endpoint switches to single-order lookup mode and the startDate, endDate, and status filters are ignored. Returns an empty result on no match (no 422). Takes precedence over clientOrderId when both are supplied.

Example:

4986126152

status
enum<string>
default:ALL

Filter list-mode results by order status. Ignored when orderId or clientOrderId is supplied.

Available options:
ALL,
FILLED,
CANCELED,
PARTIALLY_FILLED
Example:

"FILLED"

startDate
integer

Start of the query window as a Unix timestamp in seconds. Default: now - 1 month. The earliest reachable date is 6 months ago (00:00 UTC) — requests with an older startDate are rejected with a validation error.

Example:

1697000000

endDate
integer

End of the query window as a Unix timestamp in seconds. Default: now. Values greater than the current time are silently clamped to now. The maximum span between startDate and endDate is 31 days.

Example:

1699000000

offset
integer
default:0

Number of records to skip. Default: 0.

Required range: x >= 0
Example:

0

limit
integer
default:50

Maximum number of records to return. Default: 50. Minimum: 1. Maximum: 500.

Required range: 1 <= x <= 500
Example:

50

request
string
Example:

"{{request}}"

nonce
integer
Example:

1594297865000

Response

Successful response - returns order history grouped by market. Empty response if order is not yours.

Object with market names as keys, each containing an array of orders

{key}
object[]