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>' \
  --data '
{
  "market": "BTC_USDT",
  "orderId": 123,
  "clientOrderId": "<string>",
  "offset": 0,
  "limit": 50,
  "request": "<string>",
  "nonce": "<string>"
}
'
[
  {
    "orderId": 123,
    "clientOrderId": "<string>",
    "market": "<string>",
    "side": "<string>",
    "type": "<string>",
    "timestamp": 123,
    "dealMoney": "<string>",
    "dealStock": "<string>",
    "amount": "<string>",
    "left": "<string>",
    "dealFee": "<string>",
    "price": "<string>",
    "postOnly": true,
    "ioc": true,
    "status": "<string>",
    "stp": "<string>",
    "positionSide": "<string>",
    "rpi": true
  }
]

Authorizations

X-TXC-APIKEY
string
header
required

API Key authentication for private endpoints.

Required headers:

  • X-TXC-APIKEY: Your API key
  • X-TXC-PAYLOAD: Base64 encoded JSON payload
  • X-TXC-SIGNATURE: HMAC SHA512 signature

Body

application/json
market
string

Available market. Example: BTC_USDT

Example:

"BTC_USDT"

orderId
integer

Available orderId. Example: 3134995325

clientOrderId
string

Available clientOrderId. Example: customId11

offset
integer
default:0

If you want the request to return entries starting from a particular line, you can use OFFSET clause to tell it where it should start. Default: 0, Min: 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
request
string
nonce
string

Response

List of active orders

orderId
integer

Order ID

clientOrderId
string

Custom client order ID; empty string if not specified

market
string

Deal market

side
string

Order side

type
string

Order type

timestamp
number

Timestamp of order creation

dealMoney
string

If order finished - amount in money currency that is finished

dealStock
string

If order finished - amount in stock currency that is finished

amount
string

Amount

left
string

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

dealFee
string

Fee in money that you pay if order is finished

price
string

Price

postOnly
boolean

PostOnly flag

ioc
boolean

IOC flag

status
string

Order status

stp
string

Self trade prevention mode

positionSide
string

Position side (for collateral orders)

rpi
boolean

RPI order flag - indicates whether Retail Price Improvement was enabled for this order

Example:

true