Request parameters.
Get compressed, aggregate trades. Trades that fill at the time, from the same taker order, with the same price will have the quantity aggregated. Weight: 4
Request parameters.
Retrieves all order lists based on provided optional parameters.
Note that the time between startTime
and endTime
can't be longer than 24 hours.
Weight: 20
Request parameters.
Get all account orders; active, canceled, or filled. Weight: 20
Request parameters.
Current average price for a symbol. Weight: 2
Request parameters.
Cancels all active orders on a symbol. This includes orders that are part of an order list. Weight: 1
Request parameters.
Cancel an active order. Weight: 1
Request parameters.
Cancel an entire Order list Weight: 1
Request parameters.
Close out a user data stream. Weight: 2
Request parameters.
Weight: Adjusted based on the limit:
Limit | Request Weight |
---|---|
1-100 | 5 |
101-500 | 25 |
501-1000 | 50 |
1001-5000 | 250 |
Request parameters.
Current exchange trading rules and symbol information Weight: 20
Request parameters.
Get current account information. Weight: 20
Request parameters.
Get all open orders on a symbol. Careful when accessing this with no symbol. Weight: 6 for a single symbol; 80 when the symbol parameter is omitted
Request parameters.
Check an order's status. Weight: 4
Request parameters.
Retrieves a specific order list based on provided optional parameters. Weight: 4
Request parameters.
Get recent trades. Weight: 25
Request parameters.
Get older trades. Weight: 25
Request parameters.
Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time. Weight: 2
Request parameters.
Retrieves allocations resulting from SOR order placement. Weight: 20
Request parameters.
Displays the list of orders that were expired due to STP.
These are the combinations supported:
symbol
+ preventedMatchId
symbol
+ orderId
symbol
+ orderId
+ fromPreventedMatchId
(limit
will default to 500)
symbol
+ orderId
+ fromPreventedMatchId
+ limit
Weight: Case | Weight |
---|---|
If symbol is invalid |
2 |
Querying by preventedMatchId |
2 |
Querying by orderId |
20 |
Request parameters.
Get trades for a specific account and symbol.
Weight: Condition | Weight |
---|---|
Without orderId | 20 |
With orderId | 5 |
Request parameters.
Send in a new order.
This adds 1 order to the EXCHANGE_MAX_ORDERS
filter and the MAX_NUM_ORDERS
filter.
Weight: 1
Request parameters.
Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. Weight: 2
Weight: 6
Request parameters.
Reduce the quantity of an existing open order.
This adds 0 orders to the EXCHANGE_MAX_ORDERS
filter and the MAX_NUM_ORDERS
filter.
Read Order Amend Keep Priority FAQ to learn more. Weight: 4
Request parameters.
Queries all amendments of a single order. Weight: 4
Request parameters.
Cancels an existing order and places a new order on the same symbol.
Filters and Order Count are evaluated before the processing of the cancellation and order placement occurs.
A new order that was not attempted (i.e. when newOrderResult: NOT_ATTEMPTED
), will still increase the unfilled order count by 1.
Weight: 1
Request parameters.
Send in an one-cancels-the-other (OCO) pair, where activation of one order immediately cancels the other.
An OCO has 2 orders called the above order and below order.
One of the orders must be a LIMIT_MAKER/TAKE_PROFIT/TAKE_PROFIT_LIMIT
order and the other must be STOP_LOSS
or STOP_LOSS_LIMIT
order.
Price restrictions
If the OCO is on the SELL
side:
LIMIT_MAKER/TAKE_PROFIT_LIMIT
price
> Last Traded Price > STOP_LOSS/STOP_LOSS_LIMIT
stopPrice
TAKE_PROFIT stopPrice
> Last Traded Price > STOP_LOSS/STOP_LOSS_LIMIT stopPrice
If the OCO is on the BUY
side:
LIMIT_MAKER/TAKE_PROFIT_LIMIT price
< Last Traded Price < stopPrice
TAKE_PROFIT stopPrice
< Last Traded Price < STOP_LOSS/STOP_LOSS_LIMIT stopPrice
OCOs add 2 orders to the EXCHANGE_MAX_ORDERS
filter and the MAX_NUM_ORDERS
filter.
Weight: 1
Unfilled Order Count: 2
Request parameters.
Place an OTO.
An OTO (One-Triggers-the-Other) is an order list comprised of 2 orders.
The first order is called the working order and must be LIMIT
or LIMIT_MAKER
. Initially, only the working order goes on the order book.
The second order is called the pending order. It can be any order type except for MARKET
orders using parameter quoteOrderQty
. The pending order is only placed on the order book when the working order gets fully filled.
If either the working order or the pending order is cancelled individually, the other order in the order list will also be canceled or expired.
When the order list is placed, if the working order gets immediately fully filled, the placement response will show the working order as FILLED
but the pending order will still appear as PENDING_NEW
. You need to query the status of the pending order again to see its updated status.
OTOs add 2 orders to the EXCHANGE_MAX_NUM_ORDERS
filter and MAX_NUM_ORDERS
filter.
Weight: 1
Unfilled Order Count: 2
Request parameters.
Place an OTOCO.
An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders.
The first order is called the working order and must be LIMIT
or LIMIT_MAKER
. Initially, only the working order goes on the order book.
The behavior of the working order is the same as the OTO.
OTOCO has 2 pending orders (pending above and pending below), forming an OCO pair. The pending orders are only placed on the order book when the working order gets fully filled.
The rules of the pending above and pending below follow the same rules as the Order list OCO.
OTOCOs add 3 orders to the EXCHANGE_MAX_NUM_ORDERS
filter and MAX_NUM_ORDERS
filter.
Weight: 1
Unfilled Order Count: 3
Request parameters.
Send in a new OCO.
Price Restrictions:
SELL
: Limit Price > Last Price > Stop Price
BUY
: Limit Price < Last Price < Stop Price
Quantity Restrictions:
Both legs must have the same quantity.
ICEBERG
quantities however do not have to be the same
OCO
adds 2 orders to the EXCHANGE_MAX_ORDERS
filter and the MAX_NUM_ORDERS
filter.
Weight: 1
Unfilled Order Count: 2
Request parameters.
Test new order creation and signature/recvWindow long.
Creates and validates a new order but does not send it into the matching engine.
Weight: |Condition| Request Weight|
|------------ | ------------ |
|Without computeCommissionRates
| 1|
|With computeCommissionRates
|20|
Request parameters.
Test connectivity to the Rest API. Weight: 1
Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes. Weight: 2
Request parameters.
Displays the user's unfilled order count for all intervals. Weight: 40
Request parameters.
Generic function to send a request.
The API endpoint to call.
HTTP method to use (GET, POST, DELETE, etc.).
Query parameters for the request.
The time unit for the request.
A promise resolving to the response data object.
Generic function to send a signed request.
The API endpoint to call.
HTTP method to use (GET, POST, DELETE, etc.).
Query parameters for the request.
The time unit for the request.
A promise resolving to the response data object.
Places an order using smart order routing (SOR).
This adds 1 order to the EXCHANGE_MAX_ORDERS
filter and the MAX_NUM_ORDERS
filter.
Read SOR FAQ to learn more. Weight: 1
Unfilled Order Count: 1
Request parameters.
Test new order creation and signature/recvWindow using smart order routing (SOR).
Creates and validates a new order but does not send it into the matching engine.
Weight: | Condition | Request Weight |
| --------- | -------------- |
| Without computeCommissionRates
| 1 |
| With computeCommissionRates
| 20 |
Request parameters.
Weight: 4 for each requested symbol regardless of windowSize.
The weight for this request will cap at 200 once the number of symbols
in the request is more than 50.
Request parameters.
24 hour rolling window price change statistics. Careful when accessing this with no symbol. Weight:
Parameter | Symbols Provided | Weight |
---|---|---|
symbol | 1 | 2 |
symbol parameter is omitted | 80 | |
symbols | 1-20 | 2 |
21-100 | 40 | |
101 or more | 80 | |
symbols parameter is omitted | 80 |
Request parameters.
Best price/qty on the order book for a symbol or symbols. Weight:
Parameter | Symbols Provided | Weight |
---|---|---|
symbol | 1 | 2 |
symbol parameter is omitted | 4 | |
symbols | Any | 4 |
Request parameters.
Latest price for a symbol or symbols. Weight:
Parameter | Symbols Provided | Weight |
---|---|---|
symbol | 1 | 2 |
symbol parameter is omitted | 4 | |
symbols | Any | 4 |
Request parameters.
Price change statistics for a trading day.
Weight: 4 for each requested symbol.
The weight for this request will cap at 200 once the number of symbols
in the request is more than 50.
Request parameters.
Test connectivity to the Rest API and get the current server time. Weight: 1
The request is similar to klines having the same parameters and response.
uiKlines
return modified kline data, optimized for presentation of candlestick charts.
Weight: 2
Request parameters.
Get current account commission rates. Weight: 20