Get Order By ClientOid

Description

Get a single order by client order ID (including a stop order).

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

Order ID

symbol

string

required

Symbol of the contract. Please refer to Get Symbol endpoint: symbol

type

enum<string>

required

Order type, market order or limit order

Allowed values:

marketlimit

side

enum<string>

required

Transaction side

Allowed values:

buysell

price

string

required

Order Price

size

integer

required

Order quantity

value

string

required

Order value

dealValue

string

required

Executed size of funds

dealSize

integer

required

Executed quantity

stp

enum<string>

required

Self Trade Prevention is divided into these strategies: CN, CO, CB. DC not currently supported.

Allowed values:

CNCOCB

stop

string

required

Stop order type (stop limit or stop market)

stopPriceType

enum<string>

required

Trigger price type of stop orders

Allowed values:

TPMPIP

stopTriggered

boolean

required

Mark to show whether the stop order is triggered

stopPrice

number

required

Trigger price of stop orders

timeInForce

string

required

Time in force policy type

postOnly

boolean

required

Mark of post only

hidden

boolean

required

Mark of the hidden order

iceberg

boolean

required

Mark of the iceberg order

leverage

string

required

Leverage of the order

forceHold

boolean

required

A mark to force-hold the funds for an order

closeOrder

boolean

required

A mark to close the position

visibleSize

integer

required

Visible size of the iceberg order

clientOid

string

required

Unique order ID created by users to identify their orders

remark

string

required

Remark

tags

string

required

Tag order source

isActive

boolean

required

Mark of the active orders

cancelExist

boolean

required

Mark of the canceled orders

createdAt

integer <int64>

required

Order creation time

updatedAt

integer <int64>

required

Last update time

endAt

integer <int64>

required

Order Endtime

orderTime

integer <int64>

required

Order creation time in nanoseconds

settleCurrency

string

required

Settlement currency

marginMode

enum<string>

required

Margin mode: ISOLATED (isolated), CROSS (cross margin).

Allowed values:

CROSSISOLATED

avgDealPrice

string

required

Average transaction price, forward contract average transaction price = sum (transaction value) / sum (transaction quantity); reverse contract average transaction price = sum (transaction quantity) / sum (transaction value). Transaction quantity = lots * multiplier

filledSize

integer

required

Value of the executed orders

filledValue

string

required

Executed order quantity

status

enum<string>

required

order status: “open” or “done”

Allowed values:

opendone

reduceOnly

boolean

required

A mark to reduce the position size only

Example

{
  "code": "200000",
  "data": {
    "id": "250444645610336256",
    "symbol": "XRPUSDTM",
    "type": "limit",
    "side": "buy",
    "price": "0.1",
    "size": 1,
    "value": "1",
    "dealValue": "0",
    "dealSize": 0,
    "stp": "",
    "stop": "",
    "stopPriceType": "",
    "stopTriggered": false,
    "stopPrice": null,
    "timeInForce": "GTC",
    "postOnly": false,
    "hidden": false,
    "iceberg": false,
    "leverage": "3",
    "forceHold": false,
    "closeOrder": false,
    "visibleSize": 0,
    "clientOid": "5c52e11203aa677f33e493fb",
    "remark": null,
    "tags": "",
    "isActive": true,
    "cancelExist": false,
    "createdAt": 1732523858568,
    "updatedAt": 1732523858568,
    "endAt": null,
    "orderTime": 1732523858550892300,
    "settleCurrency": "USDT",
    "marginMode": "ISOLATED",
    "avgDealPrice": "0",
    "filledSize": 0,
    "filledValue": "0",
    "status": "open",
    "reduceOnly": false
  }
}