Skip to main content
POST
/
api
/
v4
/
orders
Query unexecuted(active) orders
curl --request POST \
  --url https://whitebit.com/api/v4/orders \
  --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",
  "order_id": 3134995325,
  "client_order_id": "customId11",
  "offset": 0,
  "limit": 50,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'
[
  {
    "order_id": 4180284841,
    "client_order_id": "order1987111",
    "market": "BTC_USDT",
    "side": "buy",
    "type": "limit",
    "timestamp": 1595792396.165973,
    "deal_money": "0",
    "deal_stock": "0",
    "amount": "0.01",
    "left": "0.001",
    "deal_fee": "0",
    "price": "40000",
    "postOnly": false,
    "ioc": false,
    "status": "FILLED",
    "stp": "no",
    "positionSide": "LONG",
    "rpi": true,
    "activated": 0,
    "activationCondition": "lte",
    "activation_price": "40000"
  }
]

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

Available market. Example: BTC_USDT

Example:

"BTC_USDT"

​
order_id
integer

Available order_id. Example: 3134995325

Example:

3134995325

​
client_order_id
string

Available client_order_id. Example: customId11

Example:

"customId11"

​
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: 100

Required range: x <= 100
Example:

50

​
request
string
Example:

"{{request}}"

​
nonce
string
Example:

"{{nonce}}"

Response

List of active orders

​
order_id
integer

Order ID

Example:

4180284841

​
client_order_id
string

Custom client order ID; empty string if not specified

Example:

"order1987111"

​
market
string

Deal market

Example:

"BTC_USDT"

​
side
string

Order side

Example:

"buy"

​
type
string

Order type

Example:

"limit"

​
timestamp
number

Timestamp of order creation

Example:

1595792396.165973

​
deal_money
string

If order finished - amount in money currency that is finished

Example:

"0"

​
deal_stock
string

If order finished - amount in stock currency that is finished

Example:

"0"

​
amount
string

Amount

Example:

"0.01"

​
left
string

If order not finished - rest of the amount that must be finished

Example:

"0.001"

​
deal_fee
string

Fee in money currency when order is filled

Example:

"0"

​
price
string

Price

Example:

"40000"

​
postOnly
boolean

PostOnly flag

Example:

false

​
ioc
boolean

IOC flag

Example:

false

​
status
string

Order status

Example:

"FILLED"

​
stp
string

Self trade prevention mode

Example:

"no"

​
positionSide
string

Position side (for collateral orders)

Example:

"LONG"

​
rpi
boolean

Indicates Retail Price Improvement (RPI) mode for the order.

Example:

true

​
activated
integer

Activation status of the stop order. 0 = not yet triggered (waiting for the activation_price condition to be met). 1 = triggered (the stop condition has been met and the order is now active).

Example:

0

​
activationCondition
enum<string>

Condition that triggers the stop order. "lte" = activate when the market price falls to or below activation_price. "gte" = activate when the market price rises to or above activation_price.

Available options:
lte,
gte
Example:

"lte"

​
activation_price
string

The trigger price for the stop order. Always equals the activation_price value submitted in the request.

Example:

"40000"