Get Order By OrderId

Description

This endpoint can be used to obtain information for a single Margin order using the order ID.

After the user successfully places an order, the order is in the Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.

Tips

If the order is not an active order, you can only get data within the time range of 7 * 24 hours (i.e.: from the current time to 7 * 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 7 * 24 hours by default.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

code

string

required

data

object

required

string

required

The unique order id generated by the trading system

symbol

string

required

symbol

Examples:

BTC-USDTETH-USDTKCS-USDT

opType

string

required

type

enum<string>

required

Specify if the order is a 'limit' order or 'market' order.

Allowed values:

limitmarket

side

enum<string>

required

Buy or sell

Allowed values:

buysell

price

string

required

Order Price

size

string

required

Order Size

funds

string

required

Order Funds

dealSize

string

required

Number of filled transactions

dealFunds

string

required

Funds of filled transactions

fee

string

required

Handling fees

feeCurrency

string

required

Currency used to calculate trading fee

stp

enum<string>

optional

Self Trade Prevention is divided into these strategies: CN, CO, CB , and DC

Allowed values:

DCCOCNCB

stop

string

optional

stopTriggered

boolean

required

stopPrice

string

required

timeInForce

enum<string>

required

Time in force

Allowed values:

GTCGTTIOCFOK

postOnly

boolean

required

Whether it’s a postOnly order.

hidden

boolean

required

Whether it’s a hidden order.

iceberg

boolean

required

Whether it’s a iceberg order.

visibleSize

string

required

Visible size of iceberg order in order book.

cancelAfter

integer

required

A GTT timeInForce that expires in n seconds

channel

string

required

clientOid

string

required

Client Order Id, unique identifier created by the user

remark

string

required

Order placement remarks

tags

string

optional

Order tag

cancelExist

boolean

required

Whether there is a cancellation record for the order.

createdAt

integer <int64>

required

lastUpdatedAt

integer <int64>

required

tradeType

string

required

Trade type, redundancy param

inOrderBook

boolean

required

Whether to enter the orderbook: True: enter the orderbook; False: do not enter the orderbook

cancelledSize

string

required

Number of canceled transactions

cancelledFunds

string

required

Funds of canceled transactions

remainSize

string

required

Number of remain transactions

remainFunds

string

required

Funds of remain transactions

tax

string

required

Users in some regions have this field

active

boolean

required

Order status: true-The status of the order is active; false-The status of the order is done

Example

{
  "code": "200000",
  "data": {
    "id": "671667306afcdb000723107f",
    "symbol": "BTC-USDT",
    "opType": "DEAL",
    "type": "limit",
    "side": "buy",
    "price": "50000",
    "size": "0.00001",
    "funds": "0.5",
    "dealSize": "0",
    "dealFunds": "0",
    "fee": "0",
    "feeCurrency": "USDT",
    "stp": null,
    "stop": null,
    "stopTriggered": false,
    "stopPrice": "0",
    "timeInForce": "GTC",
    "postOnly": false,
    "hidden": false,
    "iceberg": false,
    "visibleSize": "0",
    "cancelAfter": 0,
    "channel": "API",
    "clientOid": "5c52e11203aa677f33e493fb",
    "remark": null,
    "tags": null,
    "cancelExist": false,
    "createdAt": 1729521456248,
    "lastUpdatedAt": 1729651011877,
    "tradeType": "MARGIN_TRADE",
    "inOrderBook": true,
    "cancelledSize": "0",
    "cancelledFunds": "0",
    "remainSize": "0.00001",
    "remainFunds": "0.5",
    "tax": "0",
    "active": true
  }
}