Welcome to the new WEEX API documentation. Looking for the previous version?Switch to the legacy docs
WEEX
WEEX Spot REST API

Trade

Endpoint

Place Order (TRADE)

Place Order (TRADE).

POST
/api/v3/order
https://api-spot.weex.com

Place Order (TRADE) › query Parameters

symbol
​string · required

Trading pair, e.g. BTCUSDT.

side
​string · required

Order side. Supported values: BUY, SELL.

type
​string · required

Order type. Supported values: LIMIT, MARKET.

quantity
​string · required

Order quantity.

timeInForce
​string

Time-in-force policy. Required when type = LIMIT. Supported values: GTC, IOC, FOK.

price
​string

Limit price. Required when type = LIMIT.

newClientOrderId
​string

Client-defined order ID (if omitted, the system assigns one). If an active order already uses the same newClientOrderId, the API returns success but does not create a duplicate order.

Place Order (TRADE) › Responses

200

Successful response

symbol
​string

Trading pair.

orderId
​integer

Order ID generated by the system.

clientOrderId
​string

Client-defined order ID.

transactTime
​integer

Order acceptance timestamp (ms).


Batch Place Orders (TRADE)

Batch Place Orders (TRADE).

POST
/api/v3/order/batch
https://api-spot.weex.com

Batch Place Orders (TRADE) › query Parameters

symbol
​string · required

Trading pair, e.g. BTCUSDT.

orderList
​array · required

Up to 10 order definitions.

side
​string · required

BUY or SELL.

type
​string · required

LIMIT or MARKET.

quantity
​string · required

Order quantity.

Field
​string

Description

timeInForce
​string

Required when type = LIMIT. Values: GTC, IOC, FOK.

price
​string

Limit price when type = LIMIT.

newClientOrderId
​string

Client-defined order ID.

Batch Place Orders (TRADE) › Responses

200

Successful response

​object[]

Per-order result list.


Cancel Order (TRADE)

Cancel Order (TRADE).

DELETE
/api/v3/order
https://api-spot.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight1

Cancel Order (TRADE) › query Parameters

orderId
​integer

Order ID to cancel. Required when origClientOrderId is not supplied.

origClientOrderId
​string

Client order ID to cancel. Required when orderId is not supplied.

Cancel Order (TRADE) › Responses

200

Successful response

orderId
​integer

Cancelled order ID.

status
​string

Final status (e.g. CANCELED).


Cancel All Orders by Symbol (TRADE)

Cancel All Orders by Symbol (TRADE).

DELETE
/api/v3/openOrders
https://api-spot.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight5

Cancel All Orders by Symbol (TRADE) › query Parameters

symbol
​string · required

Trading pair whose open orders should be cancelled.

Cancel All Orders by Symbol (TRADE) › Responses

200

Successful response

​object[]
orderId
​integer

Cancelled order ID.

status
​string

Final order status.


Batch Cancel Orders (TRADE)

Batch Cancel Orders (TRADE).

DELETE
/api/v3/order/batch
https://api-spot.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight5

Batch Cancel Orders (TRADE) › query Parameters

orderIds
​array

Order IDs to cancel. Required when origClientOrderIds is empty.

origClientOrderIds
​array

Client order IDs to cancel. Required when orderIds is empty.

Batch Cancel Orders (TRADE) › Responses

200

Successful response

​object[]

Per-order cancel result.


Get Order Details (USER_DATA)

Get Order Details (USER_DATA).

GET
/api/v3/order
https://api-spot.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight2

Get Order Details (USER_DATA) › query Parameters

orderId
​integer

Order ID. Required when origClientOrderId is not supplied.

origClientOrderId
​string

Client order ID. Required when orderId is not supplied.

Get Order Details (USER_DATA) › Responses

200

Successful response

symbol
​string

Trading pair.

orderId
​integer

Order ID.

clientOrderId
​string

Client-defined order ID.

price
​string

Order price.

origQty
​string

Original order quantity.

executedQty
​string

Filled quantity.

cummulativeQuoteQty
​string

Filled amount in quote asset.

status
​string

Order status (e.g. NEW, FILLED, CANCELED).

timeInForce
​string

Time-in-force policy.

type
​string

Order type.

side
​string

BUY or SELL.

time
​integer

Creation time (ms).

updateTime
​integer

Last update time (ms).

isWorking
​boolean

Whether the order is active.


Get Current Open Orders (USER_DATA)

Get Current Open Orders (USER_DATA).

GET
/api/v3/openOrders
https://api-spot.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight3

Get Current Open Orders (USER_DATA) › query Parameters

symbol
​string

Filter by trading pair. If omitted, returns open orders for all symbols.

Get Current Open Orders (USER_DATA) › Responses

200

Successful response

​object[]
symbol
​string

Trading pair.

orderId
​integer

Order ID.

clientOrderId
​string

Client-defined order ID.

price
​string

Order price.

origQty
​string

Original order quantity.

executedQty
​string

Filled quantity.

cummulativeQuoteQty
​string

Filled amount in quote asset.

status
​string

Order status (e.g. NEW, PARTIALLY_FILLED).

timeInForce
​string

Time-in-force policy.

type
​string

Order type.

side
​string

BUY or SELL.

time
​integer

Creation time (ms).

updateTime
​integer

Last update time (ms).

isWorking
​boolean

Whether the order is currently working.


Get All Orders (USER_DATA)

Get All Orders (USER_DATA).

GET
/api/v3/allOrders
https://api-spot.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight10

Get All Orders (USER_DATA) › query Parameters

symbol
​string · required

Trading pair to query.

startTime
​integer

Start time in milliseconds.

endTime
​integer

End time in milliseconds. Must be greater than or equal to startTime.

limit
​integer

Number of records per page (default 100, maximum 200).

Get All Orders (USER_DATA) › Responses

200

Successful response

​object[]
symbol
​string

Trading pair.

orderId
​integer

Order ID.

clientOrderId
​string

Client-defined order ID.

price
​string

Order price.

origQty
​string

Original order quantity.

executedQty
​string

Filled quantity.

cummulativeQuoteQty
​string

Filled amount in quote asset.

status
​string

Order status (e.g. NEW, FILLED, CANCELED).

timeInForce
​string

Time-in-force policy.

type
​string

Order type.

side
​string

BUY or SELL.

time
​integer

Creation time (ms).

updateTime
​integer

Last update time (ms).

isWorking
​boolean

Whether the order is active.


Get Trade History (USER_DATA)

Get Trade History (USER_DATA).

GET
/api/v3/myTrades
https://api-spot.weex.com
Request weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate-limit capacity.
Learn more in the Access Restrictions section.
IP weight5

Get Trade History (USER_DATA) › query Parameters

symbol
​string · required

Trading pair.

orderId
​integer

Filter by order ID.

startTime
​integer

Start time (ms).

endTime
​integer

End time (ms). Must be ≥ startTime.

limit
​integer

Page size (default 100, maximum 200).

Get Trade History (USER_DATA) › Responses

200

Successful response

​object[]
symbol
​string

Trading pair.

id
​integer

Trade identifier.

orderId
​integer

Related order ID.

price
​string

Trade price.

qty
​string

Filled quantity (base asset).

quoteQty
​string

Filled amount (quote asset).

commission
​string

Commission amount.

time
​integer

Trade time (ms).

isBuyer
​boolean

Whether the user was the buyer.