Get Order by Client Order Id

GET /api/v1/trade/orderByClientOrderId

Get an order. Please try GET /v1/trade/order for normal query.

Permission: Read

Weight: 1

Request parameters

Name

Type

Mandatory

Description

clientOrderId

number

YES

Client order id.

Response format

Name

Type

Description

orderId

number

Order id

symbol

string

Symbol.

type

string

LIMIT / MARKET

side

string

BUY / SELL

price

string

Price.

size

string

Order quantity.

amount

string

The amount of market buy order.

filledSize

string

Filled quantity of order.

filledAmount

string

Filled amount of order.

fee

string

Transaction fee.

feeCoin

string

Currency of transaction fee.

status

string

OPEN / CLOSED

IOC

boolean

IOC

clientOrderId

string

Client id

source

string

Source of order, MANUAL / API

createTime

number

Create timestamp in millisecond.

updateTime

number

Update timestamp in millisecond.

Error code

  • TRADE_ORDER_NOT_FOUND Order not found.

  • TRADE_INVALID_SYMBOL Invalid symbol.

  • TRADE_PARAMETER_ERROR Parameter error.

Request example

GET https://{site}/api/v1/trade/orderByClientOrderId?symbol=BTC_USDT&clientOrderId=9e3d93d6-e9a4-465a-a39c-2e48568fe194

Response example

{ 
  "data": {
    "orderId": 1234567890,
    "symbol": "BTC_USDT",
    "type": "LIMIT",
    "side": "SELL",
    "price": "30000.00",
    "size": "0.1000",
    "filledSize": "0.0500",
    "filledAmount": "1500.00",
    "fee":  "0.15",
    "feeCoin":  "USDT",
    "status": "OPEN",
    "IOC":  false,
    "clientOrderId":  "9e3d93d6-e9a4-465a-a39c-2e48568fe194",
    "source": "API",
    "createTime": 1566676132311,
    "updateTime": 1566676132311
  },
  "result": true,
  "timestamp": 1566691672311
}

Last updated