Get order

GET🔒 Trading

⚡ Query: 15 req/s per endpoint · 30 req/s per user

tip

Try It Out — test this endpoint in the API Explorer

Retrieve a single order by orderId or clOrderId. Returns 404 if the order does not exist or is inactive.

Request Parameters

Name	Type	Required	Description
orderId	String	No	Order ID to look up; at least one of orderId or clOrderId is required
clOrderId	String	No	Client-supplied order ID to look up; at least one of orderId or clOrderId is required

Response Content

Name	Type	Description
requestId	Long	Request identifier associated with the order submission.
orderId	String	Server-assigned unique order identifier.
clOrderId	String	Client-supplied order identifier (custom tag).
symbol	String	Trading pair, formatted as BASE-QUOTE (e.g. BTC-USDT).
quote	String	Quote currency of the trading pair.
orderState	String	Current order status label (e.g. active, inactive, cancelled).
orderType	Integer	Numeric order-type code (limit, market, peg, TWAP).
orderSide	String	Order side: BUY or SELL.
orderPrice	Double	Order limit price. Zero for market orders.
orderValue	Double	Current order value expressed in the user's account currency.
timestamp	Long	Order creation timestamp in Unix epoch milliseconds.
timeInForce	String	Time-in-force policy: GTC, IOC, FOK, or null if not applicable.
orderCurrency	String	Indicates which size fields are populated: "quote" (quote-denominated) or "base" (base-denominated).
originalOrderBaseSize	Double	Original order size in base currency. Populated only when orderCurrency is "base".
originalOrderQuoteSize	Double	Original order size in quote currency. Populated only when orderCurrency is "quote".
currentOrderBaseSize	Double	Current outstanding order size in base currency. Populated only when orderCurrency is "base".
currentOrderQuoteSize	Double	Current outstanding order size in quote currency. Populated only when orderCurrency is "quote".
remainingOrderBaseSize	Double	Remaining unfilled size in base currency. Populated only when orderCurrency is "base".
remainingOrderQuoteSize	Double	Remaining unfilled size in quote currency. Populated only when orderCurrency is "quote".
totalFilledBaseSize	Double	Cumulative filled quantity in base currency.
avgFilledPrice	Double	Volume-weighted average fill price across all executions of this order.
orderDetailType	String	Order detail category classifying the order's purpose or subtype. — TWAP · PARTIAL_LIQUIDATION · FORCED_MARKET_BUY · FORCED_MARKET_SELL
orderDetail	Object
triggerOrder	Boolean	True if this is a trigger (conditional) order.
triggered	Boolean	True once the trigger condition has fired and the underlying order has been released.
triggerUseLastPrice	Boolean	True if the trigger evaluates against the last-traded price; false if it evaluates against the mark price. Only meaningful for trigger orders.
triggerPrice	Double	Effective trigger price. Only meaningful for trigger orders.
triggerOriginalPrice	Double	Trigger price originally submitted by the client. Only meaningful for trigger orders.
triggerOrderType	Integer	Numeric trigger order-type code (stop-loss, take-profit, stop-loss-limit, or take-profit-limit). Only meaningful for trigger orders.
triggerStopPrice	Double	Stop price for the trigger order. Only meaningful for trigger orders.
triggerTrailingStopDeviation	Double	Trailing stop deviation from the reference price. Only meaningful for trailing-stop trigger orders.
trailValue	Double	Trailing offset magnitude. Only meaningful for trailing-stop orders.
trailValueType	String	Interpretation of trailValue (e.g. absolute amount or percentage). Only meaningful for trailing-stop orders. — DISTANCE · PERCENTAGE
pegPriceMin	Double	Lower cap of the peg price band. Only meaningful for peg orders.
pegPriceMax	Double	Upper cap of the peg price band. Only meaningful for peg orders.
pegPriceDeviation	Double	Offset applied to the reference price when pegging. Only meaningful for peg orders.
currentPegPrice	Double	Current effective peg price. Only meaningful for peg orders.
wrapperOrder	Boolean	True if the order is a wrapper for a group of related orders (e.g. bracket/OCO).
activationPrice	Double	Activation price at which the order becomes eligible for execution. Only present for orders that use an activation-price feature.
activationPriceType	String	Reference price type used when evaluating activationPrice. Only present for orders that use an activation-price feature. — INDEX_PRICE · LAST_PRICE · MARK_PRICE

example

GEThttps://api.btse.com/spot/api/v4/trade/order

Response (default)

{
  "requestId": 5219582705252738000,
  "orderId": "4eca2eb4-e6ad-4355-ae12-5ce757b105b3",
  "clOrderId": null,
  "symbol": "BTC-USD",
  "quote": "USD",
  "orderState": "ORDER_INSERTED",
  "orderType": 76,
  "orderSide": "BUY",
  "orderPrice": 60413.8,
  "orderValue": 0.604138,
  "timestamp": 1784891308061,
  "timeInForce": "GTC",
  "orderCurrency": "base",
  "originalOrderBaseSize": 0.00001,
  "originalOrderQuoteSize": null,
  "currentOrderBaseSize": 0.00001,
  "currentOrderQuoteSize": null,
  "remainingOrderBaseSize": 0.00001,
  "remainingOrderQuoteSize": null,
  "totalFilledBaseSize": 0,
  "avgFilledPrice": 0,
  "orderDetailType": null,
  "orderDetail": null,
  "triggerOrder": false,
  "triggered": false,
  "triggerUseLastPrice": false,
  "triggerPrice": 0,
  "triggerOriginalPrice": 0,
  "triggerOrderType": 0,
  "triggerStopPrice": 0,
  "triggerTrailingStopDeviation": 0,
  "trailValue": 0,
  "trailValueType": "DISTANCE",
  "pegPriceMin": 0,
  "pegPriceMax": 0,
  "pegPriceDeviation": 0,
  "currentPegPrice": 60413.8,
  "wrapperOrder": false,
  "activationPrice": null,
  "activationPriceType": null
}