web-socket-api.md

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Public WebSocket API for Binance](#public-websocket-api-for-binance)
  - [General API Information](#general-api-information)
  - [Request format](#request-format)
  - [Response format](#response-format)
    - [Status codes](#status-codes)
  - [Conditional fields in Order Responses](#conditional-fields-in-order-responses)
  - [Event format](#event-format)
  - [Connection events](#connection-events)
    - [Server Shutdown](#server-shutdown)
  - [Rate limits](#rate-limits)
    - [Connection limits](#connection-limits)
    - [General information on rate limits](#general-information-on-rate-limits)
      - [How to interpret rate limits](#how-to-interpret-rate-limits)
      - [How to show/hide rate limit information](#how-to-showhide-rate-limit-information)
    - [IP limits](#ip-limits)
    - [Unfilled Order Count](#unfilled-order-count)
  - [Request security](#request-security)
    - [SIGNED request security](#signed-request-security)
      - [Signature Case Sensitivity](#signature-case-sensitivity)
    - [Timing security](#timing-security)
    - [SIGNED request example (HMAC)](#signed-request-example-hmac)
    - [SIGNED request example (RSA)](#signed-request-example-rsa)
    - [SIGNED Request Example (Ed25519)](#signed-request-example-ed25519)
  - [Session Authentication](#session-authentication)
    - [Authenticate after connection](#authenticate-after-connection)
    - [Authorize _ad hoc_ requests](#authorize-_ad-hoc_-requests)
  - [Data sources](#data-sources)
- [Public API requests](#public-api-requests)
  - [General requests](#general-requests)
    - [Test connectivity](#test-connectivity)
    - [Check server time](#check-server-time)
    - [Exchange information](#exchange-information)
    - [Query Execution Rules](#query-execution-rules)
  - [Market data requests](#market-data-requests)
    - [Order book](#order-book)
    - [Recent trades](#recent-trades)
    - [Historical trades](#historical-trades)
    - [Historical Block Trades](#historical-block-trades)
    - [Aggregate trades](#aggregate-trades)
    - [Klines](#klines)
    - [UI Klines](#ui-klines)
    - [Current average price](#current-average-price)
    - [24hr ticker price change statistics](#24hr-ticker-price-change-statistics)
    - [Trading Day Ticker](#trading-day-ticker)
    - [Rolling window price change statistics](#rolling-window-price-change-statistics)
    - [Symbol price ticker](#symbol-price-ticker)
    - [Symbol order book ticker](#symbol-order-book-ticker)
    - [Query Reference Price](#query-reference-price)
    - [Query Reference Price Calculation](#query-reference-price-calculation)
  - [Authentication requests](#authentication-requests)
    - [Query session status](#query-session-status)
    - [Log out of the session](#log-out-of-the-session)
    - [Log in with API key (USER_DATA)](#log-in-with-api-key-user_data)
  - [Trading requests](#trading-requests)
    - [Place new order (TRADE)](#place-new-order-trade)
    - [Test new order (TRADE)](#test-new-order-trade)
    - [Cancel order (TRADE)](#cancel-order-trade)
    - [Cancel and replace order (TRADE)](#cancel-and-replace-order-trade)
    - [Order Amend Keep Priority (TRADE)](#order-amend-keep-priority-trade)
    - [Cancel open orders (TRADE)](#cancel-open-orders-trade)
    - [Place new OCO - Deprecated (TRADE)](#place-new-oco---deprecated-trade)
    - [Place new Order list - OCO (TRADE)](#place-new-order-list---oco-trade)
    - [Place new Order list - OTO (TRADE)](#place-new-order-list---oto-trade)
    - [Place new Order list - OTOCO (TRADE)](#place-new-order-list---otoco-trade)
    - [OPO (TRADE)](#opo-trade)
    - [OPOCO (TRADE)](#opoco-trade)
    - [Cancel Order list (TRADE)](#cancel-order-list-trade)
    - [Place new order using SOR (TRADE)](#place-new-order-using-sor-trade)
    - [Test new order using SOR (TRADE)](#test-new-order-using-sor-trade)
  - [Account requests](#account-requests)
    - [Account information (USER_DATA)](#account-information-user_data)
    - [Query order (USER_DATA)](#query-order-user_data)
    - [Current open orders (USER_DATA)](#current-open-orders-user_data)
    - [Account order history (USER_DATA)](#account-order-history-user_data)
    - [Query Order list (USER_DATA)](#query-order-list-user_data)
    - [Current open Order lists (USER_DATA)](#current-open-order-lists-user_data)
    - [Account order list history (USER_DATA)](#account-order-list-history-user_data)
    - [Account trade history (USER_DATA)](#account-trade-history-user_data)
    - [Unfilled Order Count (USER_DATA)](#unfilled-order-count-user_data)
    - [Account prevented matches (USER_DATA)](#account-prevented-matches-user_data)
    - [Account allocations (USER_DATA)](#account-allocations-user_data)
    - [Account Commission Rates (USER_DATA)](#account-commission-rates-user_data)
    - [Query Order Amendments (USER_DATA)](#query-order-amendments-user_data)
    - [Query Relevant Filters (USER_DATA)](#query-relevant-filters-user_data)
  - [User Data Stream requests](#user-data-stream-requests)
    - [User Data Stream subscription](#user-data-stream-subscription)
    - [Subscribe to User Data Stream (USER_STREAM)](#subscribe-to-user-data-stream-user_stream)
    - [Unsubscribe from User Data Stream](#unsubscribe-from-user-data-stream)
    - [Listing all subscriptions](#listing-all-subscriptions)
    - [Subscribe to User Data Stream through signature subscription (USER_STREAM)](#subscribe-to-user-data-stream-through-signature-subscription-user_stream)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<a id="general-api-information"></a>

<a id="general-websocket-api-information"></a>

# Public WebSocket API for Binance

## General API Information

- The base endpoint is: **`wss://ws-api.binance.com:443/ws-api/v3`**.
  - If you experience issues with the standard 443 port, alternative port 9443 is also available.
  - The base endpoint for [testnet](https://testnet.binance.vision/) is:
    `wss://ws-api.testnet.binance.vision/ws-api/v3`
- A single connection to the API is only valid for 24 hours; expect to be disconnected after the
  24-hour mark.
- A [`serverShutdown`](#server-shutdown) event will be sent when the server is about to shutdown,
  resulting in disconnection. Please establish a new connection as soon as possible to prevent
  interruption.
- We support HMAC, RSA, and Ed25519 keys. For more information, please see
  [API Key types](faqs/api_key_types.md).
- Responses are in JSON by default. To receive responses in SBE, refer to the
  [SBE FAQ](faqs/sbe_faq.md) page.
- If your request contains a symbol name containing non-ASCII characters, then the response may
  contain non-ASCII characters encoded in UTF-8.
- Some methods may return asset and/or symbol names containing non-ASCII characters encoded in UTF-8
  even if the request did not contain non-ASCII characters.
- The WebSocket server will send a `ping frame` every 20 seconds.
  - If the WebSocket server does not receive a `pong frame` back from the connection within a minute
    the connection will be disconnected.
  - When you receive a ping, you must send a pong with a copy of ping's payload as soon as possible.
  - Unsolicited `pong frames` are allowed, but will not prevent disconnection. **It is recommended
    that the payload for these pong frames are empty.**
- Data is returned in **chronological order**, unless noted otherwise.
  - Without `startTime` or `endTime`, returns the most recent items up to the limit.
  - With `startTime`, returns oldest items from `startTime` up to the limit.
  - With `endTime`, returns most recent items up to `endTime` and the limit.
  - With both, behaves like `startTime` but does not exceed `endTime`.
- All timestamps in the JSON responses are in **milliseconds in UTC by default**. To receive the
  information in microseconds, please add the parameter `timeUnit=MICROSECOND` or
  `timeUnit=microsecond` in the URL.
- Timestamp parameters (e.g. `startTime`, `endTime`, `timestamp`) can be passed in milliseconds or
  microseconds.
- All field names and values are **case-sensitive**, unless noted otherwise.
- If there are enums or terms you want clarification on, please see
  [SPOT Glossary](faqs/spot_glossary.md) for more information.
- APIs have a timeout of 10 seconds when processing a request. If a response from the Matching
  Engine takes longer than this, the API responds with "Timeout waiting for response from backend
  server. Send status unknown; execution status unknown."
  [(-1007 TIMEOUT)](errors.md#-1007-timeout)
  - This does not always mean that the request failed in the Matching Engine.
  - If the status of the request has not appeared in
    [User Data Stream](user-data-stream.md), please perform an API query for its status.
- **Please avoid SQL keywords in requests** as they may trigger a security block by a WAF (Web
  Application Firewall) rule. See https://www.binance.com/en/support/faq/detail/360004492232 for
  more details.

## Request format

Requests must be sent as JSON in **text frames**, one request per frame.

Example of request:

```json
{
  "id": "e2a85d9f-07a5-4f94-8d5f-789dc3deb097",
  "method": "order.place",
  "params": {
    "symbol": "BTCUSDT",
    "side": "BUY",
    "type": "LIMIT",
    "price": "0.1",
    "quantity": "10",
    "timeInForce": "GTC",
    "timestamp": 1655716096498,
    "apiKey": "T59MTDLWlpRW16JVeZ2Nju5A5C98WkMm8CSzWC4oqynUlTm1zXOxyauT8LmwXEv9",
    "signature": "5942ad337e6779f2f4c62cd1c26dba71c91514400a24990a3e7f5edec9323f90"
  }
}
```

Request fields:

| Name     | Type                  | Mandatory | Description                                                   |
| -------- | --------------------- | --------- | ------------------------------------------------------------- |
| `id`     | INT / STRING / `null` | YES       | Arbitrary ID used to match responses to requests              |
| `method` | STRING                | YES       | Request method name                                           |
| `params` | OBJECT                | NO        | Request parameters. May be omitted if there are no parameters |

- Request `id` is truly arbitrary. You can use UUIDs, sequential IDs, current timestamp, etc. The
  server does not interpret `id` in any way, simply echoing it back in the response.

  You can freely reuse IDs within a session. However, be careful to not send more than one request
  at a time with the same ID, since otherwise it might be impossible to tell the responses apart.

- Request method names may be prefixed with explicit version: e.g., `"v3/order.place"`.

- The order of `params` is not significant.

## Response format

Responses are returned as JSON in **text frames**, one response per frame.

Example of successful response:

```json
{
  "id": "e2a85d9f-07a5-4f94-8d5f-789dc3deb097",
  "status": 200,
  "result": {
    "symbol": "BTCUSDT",
    "orderId": 12510053279,
    "orderListId": -1,
    "clientOrderId": "a097fe6304b20a7e4fc436",
    "transactTime": 1655716096505,
    "price": "0.10000000",
    "origQty": "10.00000000",
    "executedQty": "0.00000000",
    "origQuoteOrderQty": "0.000000",
    "cummulativeQuoteQty": "0.00000000",
    "status": "NEW",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "BUY",
    "workingTime": 1655716096505,
    "selfTradePreventionMode": "NONE"
  },
  "rateLimits": [
    {
      "rateLimitType": "ORDERS",
      "interval": "SECOND",
      "intervalNum": 10,
      "limit": 50,
      "count": 12
    },
    {
      "rateLimitType": "ORDERS",
      "interval": "DAY",
      "intervalNum": 1,
      "limit": 160000,
      "count": 4043
    },
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000,
      "count": 321
    }
  ]
}
```

Example of failed response:

```json
{
  "id": "e2a85d9f-07a5-4f94-8d5f-789dc3deb097",
  "status": 400,
  "error": {
    "code": -2010,
    "msg": "Account has insufficient balance for requested action."
  },
  "rateLimits": [
    {
      "rateLimitType": "ORDERS",
      "interval": "SECOND",
      "intervalNum": 10,
      "limit": 50,
      "count": 13
    },
    {
      "rateLimitType": "ORDERS",
      "interval": "DAY",
      "intervalNum": 1,
      "limit": 160000,
      "count": 4044
    },
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000,
      "count": 322
    }
  ]
}
```

Response fields:

<table>
<thead>
  <tr>
    <th>Name</th>
    <th>Type</th>
    <th>Mandatory</th>
    <th>Description</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td><code>id</code></td>
    <td>INT / STRING / <code>null</code></td>
    <td>YES</td>
    <td>Same as in the original request</td>
  </tr>
  <tr>
    <td><code>status</code></td>
    <td>INT</td>
    <td>YES</td>
    <td>Response status. See <a href="#status-codes">Status codes</a></td>
  </tr>
  <tr>
    <td><code>result</code></td>
    <td>OBJECT / ARRAY</td>
    <td rowspan="2">YES</td>
    <td>Response content. Present if request succeeded</td>
  </tr>
  <tr>
    <td><code>error</code></td>
    <td>OBJECT</td>
    <td>Error description. Present if request failed</td>
  </tr>
  <tr>
    <td><code>rateLimits</code></td>
    <td>ARRAY</td>
    <td>NO</td>
    <td>Rate limiting status. See <a href="#rate-limits">Rate limits</a></td>
  </tr>
</tbody>
</table>

### Status codes

Status codes in the `status` field are the same as in HTTP.

Here are some common status codes that you might encounter:

- `200` indicates a successful response.
- `4XX` status codes indicate invalid requests; the issue is on your side.
  - `400` – your request failed, see `error` for the reason.
  - `403` – you have been blocked by the Web Application Firewall. This can indicate a rate limit
    violation or a security block. See https://www.binance.com/en/support/faq/detail/360004492232
    for more details.
  - `409` – your request partially failed but also partially succeeded, see `error` for details.
  - `418` – you have been auto-banned for repeated violation of rate limits.
  - `429` – you have exceeded API request rate limit, please slow down.
- `5XX` status codes indicate internal errors; the issue is on Binance's side.
  - **Important:** If a response contains 5xx status code, it **does not** necessarily mean that
    your request has failed. Execution status is _unknown_ and the request might have actually
    succeeded. Please use query methods to confirm the status. You might also want to establish a
    new WebSocket connection for that.

See [Error codes for Binance](errors.md) for a list of error codes and messages.

<a id="conditional-fields-in-order-responses"></a>

## Conditional fields in Order Responses

There are fields in the order responses (e.g. order placement, order query, order cancellation) that
appear only if certain conditions are met.

These fields can apply to order lists.

The fields are listed below:

| Field               | Description                                                                                                         | Visibility conditions                                                                     | Examples                                   |
| ------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------ |
| `icebergQty`        | Quantity for the iceberg order                                                                                      | Appears only if the parameter `icebergQty` was sent in the request.                       | `"icebergQty": "0.00000000"`               |
| `preventedMatchId`  | When used in combination with `symbol`, can be used to query a prevented match.                                     | Appears only if the order expired due to STP.                                             | `"preventedMatchId": 0`                    |
| `preventedQuantity` | Order quantity that expired due to STP                                                                              | Appears only if the order expired due to STP.                                             | `"preventedQuantity": "1.200000"`          |
| `stopPrice`         | Price when the algorithmic order will be triggered                                                                  | Appears for `STOP_LOSS`. `TAKE_PROFIT`, `STOP_LOSS_LIMIT` and `TAKE_PROFIT_LIMIT` orders. | `"stopPrice": "23500.00000000"`            |
| `strategyId`        | Can be used to label an order that's part of an order strategy.                                                     | Appears if the parameter was populated in the request.                                    | `"strategyId": 37463720`                   |
| `strategyType`      | Can be used to label an order that is using an order strategy.                                                      | Appears if the parameter was populated in the request.                                    | `"strategyType": 1000000`                  |
| `trailingDelta`     | Delta price change required before order activation                                                                 | Appears for Trailing Stop Orders.                                                         | `"trailingDelta": 10`                      |
| `trailingTime`      | Time when the trailing order is now active and tracking price changes                                               | Appears only for Trailing Stop Orders.                                                    | `"trailingTime": -1`                       |
| `usedSor`           | Field that determines whether order used SOR                                                                        | Appears when placing orders using SOR                                                     | `"usedSor": true`                          |
| `workingFloor`      | Field that determines whether the order is being filled by the SOR or by the order book the order was submitted to. | Appears when placing orders using SOR                                                     | `"workingFloor": "SOR"`                    |
| `pegPriceType`      | Price peg type                                                                                                      | Only for pegged orders                                                                    | `"pegPriceType": "PRIMARY_PEG"`            |
| `pegOffsetType`     | Price peg offset type                                                                                               | Only for pegged orders, if requested                                                      | `"pegOffsetType": "PRICE_LEVEL"`           |
| `pegOffsetValue`    | Price peg offset value                                                                                              | Only for pegged orders, if requested                                                      | `"pegOffsetValue": 5`                      |
| `peggedPrice`       | Current price order is pegged at                                                                                    | Only for pegged orders, once determined                                                   | `"peggedPrice": "87523.83710000"`          |
| `expiryReason`      | Cause of the order’s expiration                                                                                     | When an order has expired                                                                 | `"expiryReason": "INSUFFICIENT_LIQUIDITY"` |

## Event format

[User Data Stream](user-data-stream.md) events for non-SBE sessions are sent as JSON in
**text frames**, one event per frame.

Events in [SBE sessions](faqs/sbe_faq.md) will be sent as **binary frames**.

Please refer to
[`userDataStream.subscribe`](web-socket-api.md#subscribe-to-user-data-stream-user_stream)
for details on how to subscribe to User Data Stream in WebSocket API.

Example of an event:

```javascript
{
    "subscriptionId": 0,
    "event": {
        "e": "outboundAccountPosition",
        "E": 1728972148778,
        "u": 1728972148778,
        "B": [
            {
                "a": "BTC",
                "f": "11818.00000000",
                "l": "182.00000000"
            },
            {
                "a": "USDT",
                "f": "10580.00000000",
                "l": "70.00000000"
            }
        ]
    }
}
```

Event fields:

| Name             | Type   | Mandatory | Description                                                                                                                                       |
| :--------------- | :----- | :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------ |
| `event`          | OBJECT | YES       | Event payload. See [User Data Streams](user-data-stream.md)                                                                           |
| `subscriptionId` | INT    | NO        | Identifies which subscription the event is coming from. See [User Data Stream subscriptions](user-data-stream.md#general-information) |

## Connection events

<a id="serverShutdown"></a>

### Server Shutdown

`serverShutdown` event is sent when the server is about to shut down.

```javascript
{
  "event": {
    "e": "serverShutdown", // Event Type
    "E": 1770123456789     // Event Time
  }
}
```

Please establish a new connection as soon as possible to prevent interruption.

## Rate limits

### Connection limits

There is a limit of **300 connections per attempt every 5 minutes**.

The connection is per **IP address**.

### General information on rate limits

- Current API rate limits can be queried using the
  [`exchangeInfo`](web-socket-api.md#exchange-information) request.
- There are multiple rate limit types across multiple intervals.
- Responses can indicate current rate limit status in the optional `rateLimits` field.
- Requests fail with status `429` when unfilled order count or request rate limits are violated.

#### How to interpret rate limits

A response with rate limit status may look like this:

```json
{
  "id": "7069b743-f477-4ae3-81db-db9b8df085d2",
  "status": 200,
  "result": {
    "serverTime": 1656400526260
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000,
      "count": 70
    }
  ]
}
```

The `rateLimits` array describes all currently active rate limits affected by the request.

| Name            | Type | Mandatory | Description                                            |
| --------------- | ---- | --------- | ------------------------------------------------------ |
| `rateLimitType` | ENUM | YES       | Rate limit type: `REQUEST_WEIGHT`, `ORDERS`            |
| `interval`      | ENUM | YES       | Rate limit interval: `SECOND`, `MINUTE`, `HOUR`, `DAY` |
| `intervalNum`   | INT  | YES       | Rate limit interval multiplier                         |
| `limit`         | INT  | YES       | Request limit per interval                             |
| `count`         | INT  | YES       | Current usage per interval                             |

Rate limits are accounted by intervals.

For example, a `1 MINUTE` interval starts every minute. Request submitted at 00:01:23.456 counts
towards the 00:01:00 minute's limit. Once the 00:02:00 minute starts, the count will reset to zero
again.

Other intervals behave in a similar manner. For example, `1 DAY` rate limit resets at 00:00 UTC
every day, and `10 SECOND` interval resets at 00, 10, 20... seconds of each minute.

APIs have multiple rate-limiting intervals. If you exhaust a shorter interval but the longer
interval still allows requests, you will have to wait for the shorter interval to expire and reset.
If you exhaust a longer interval, you will have to wait for that interval to reset, even if shorter
rate limit count is zero.

#### How to show/hide rate limit information

`rateLimits` field is included with every response by default.

However, rate limit information can be quite bulky. If you are not interested in detailed rate limit
status of every request, the `rateLimits` field can be omitted from responses to reduce their size.

- Optional `returnRateLimits` boolean parameter in request.

  Use `returnRateLimits` parameter to control whether to include `rateLimits` fields in response to
  individual requests.

  Default request and response:

  ```json
  { "id": 1, "method": "time" }
  ```

  ```json
  {
    "id": 1,
    "status": 200,
    "result": { "serverTime": 1656400526260 },
    "rateLimits": [
      {
        "rateLimitType": "REQUEST_WEIGHT",
        "interval": "MINUTE",
        "intervalNum": 1,
        "limit": 6000,
        "count": 70
      }
    ]
  }
  ```

  Request and response without rate limit status:

  ```json
  { "id": 2, "method": "time", "params": { "returnRateLimits": false } }
  ```

  ```json
  { "id": 2, "status": 200, "result": { "serverTime": 1656400527891 } }
  ```

- Optional `returnRateLimits` boolean parameter in connection URL.

  If you wish to omit `rateLimits` from all responses by default, use `returnRateLimits` parameter
  in the query string instead:

  ```
  wss://ws-api.binance.com:443/ws-api/v3?returnRateLimits=false
  ```

  This will make all requests made through this connection behave as if you have passed
  `"returnRateLimits": false`.

  If you _want_ to see rate limits for a particular request, you need to explicitly pass the
  `"returnRateLimits": true` parameter.

**Note:** Your requests are still rate limited if you hide the `rateLimits` field in responses.

### IP limits

- Every request has a certain **weight**, added to your limit as you perform requests.
  - The heavier the request (e.g. querying data from multiple symbols), the more weight the request
    will cost.
  - Connecting to WebSocket API costs 2 weight.
- Current weight usage is indicated by the `REQUEST_WEIGHT` rate limit type.
- Use the [`exchangeInfo`](web-socket-api.md#exchange-information)
  request to keep track of the current weight limits.
- Weight is accumulated **per IP address** and is shared by all connections from that address.
- If you go over the weight limit, requests fail with status `429`.
  - This status code indicates you should back off and stop spamming the API.
  - Rate-limited responses include a `retryAfter` field, indicating when you can retry the request.
- **Repeatedly violating rate limits and/or failing to back off after receiving 429s will result in
  an automated IP ban and you will be disconnected.**
  - Requests from a banned IP address fail with status `418`.
  - `retryAfter` field indicates the timestamp when the ban will be lifted.
- IP bans are tracked and **scale in duration** for repeat offenders, **from 2 minutes to 3 days**.

Successful response indicating that in 1 minute you have used 70 weight out of your 6000 limit:

```json
{
  "id": "7069b743-f477-4ae3-81db-db9b8df085d2",
  "status": 200,
  "result": [],
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000,
      "count": 70
    }
  ]
}
```

Failed response indicating that you are banned and the ban will last until epoch `1659146400000`:

```json
{
  "id": "fc93a61a-a192-4cf4-bb2a-a8f0f0c51e06",
  "status": 418,
  "error": {
    "code": -1003,
    "msg": "Way too much request weight used; IP banned until 1659146400000. Please use WebSocket Streams for live updates to avoid bans.",
    "data": {
      "serverTime": 1659142907531,
      "retryAfter": 1659146400000
    }
  },
  "rateLimits": [
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000,
      "count": 2411
    }
  ]
}
```

### Unfilled Order Count

- Successfully placed orders update the `ORDERS` rate limit type.
- Rejected or unsuccessful orders might or might not update the `ORDERS` rate limit type.
- **Please note that if your orders are consistently filled by trades, you can continuously place
  orders on the API**. For more information, please see
  [Spot Unfilled Order Count Rules](faqs/order_count_decrement.md).
- Use the
  [`account.rateLimits.orders`](web-socket-api.md#unfilled-order-count-user_data)
  request to keep track of how many orders you have placed within this interval.
- If you exceed this, requests fail with status `429`.
  - This status code indicates you should back off and stop spamming the API.
  - Responses that have a status `429` include a `retryAfter` field, indicating when you can retry
    the request.
- This is maintained **per account** and is shared by all API keys of the account.

Successful response indicating that you have placed 12 orders in 10 seconds, and 4043 orders in the
past 24 hours:

```json
{
  "id": "e2a85d9f-07a5-4f94-8d5f-789dc3deb097",
  "status": 200,
  "result": {
    "symbol": "BTCUSDT",
    "orderId": 12510053279,
    "orderListId": -1,
    "clientOrderId": "a097fe6304b20a7e4fc436",
    "transactTime": 1655716096505,
    "price": "0.10000000",
    "origQty": "10.00000000",
    "executedQty": "0.00000000",
    "origQuoteOrderQty": "0.000000",
    "cummulativeQuoteQty": "0.00000000",
    "status": "NEW",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "BUY",
    "workingTime": 1655716096505,
    "selfTradePreventionMode": "NONE"
  },
  "rateLimits": [
    {
      "rateLimitType": "ORDERS",
      "interval": "SECOND",
      "intervalNum": 10,
      "limit": 50,
      "count": 12
    },
    {
      "rateLimitType": "ORDERS",
      "interval": "DAY",
      "intervalNum": 1,
      "limit": 160000,
      "count": 4043
    },
    {
      "rateLimitType": "REQUEST_WEIGHT",
      "interval": "MINUTE",
      "intervalNum": 1,
      "limit": 6000,
      "count": 321
    }
  ]
}
```

## Request security

- Each method has a security type indicating required API key permissions, shown next to the method
  name (e.g.,
  [Place new order (TRADE)](web-socket-api.md#place-new-order-trade)).
- If unspecified, the security type is `NONE`.
- Except for `NONE`, all methods with a security type are considered `SIGNED` requests (i.e.
  including a `signature`), except for [listenKey management](user-data-stream.md).
- Secure methods require a valid API key to be specified and authenticated.
  - API keys can be created on the
    [API Management](https://www.binance.com/en/support/faq/360002502072) page of your Binance
    account.
  - **Both API key and secret key are sensitive.** Never share them with anyone. If you notice
    unusual activity in your account, immediately revoke all the keys and contact Binance support.
- API keys can be configured to allow access only to certain types of secure methods.
  - For example, you can have an API key with `TRADE` permission for trading, while using a separate
    API key with `USER_DATA` permission to monitor your order status.
  - By default, an API key cannot `TRADE`. You need to enable trading in API Management first.

| Security type | Description                                                                |
| ------------- | -------------------------------------------------------------------------- |
| `NONE`        | Public market data                                                         |
| `TRADE`       | Trading on the exchange, placing and canceling orders                      |
| `USER_DATA`   | Private account information, such as order status and your trading history |
| `USER_STREAM` | Managing User Data Stream subscriptions                                    |

### SIGNED request security

- `SIGNED` requests require an additional parameter: `signature`, authorizing the request.

#### Signature Case Sensitivity

- **HMAC:** Signatures generated using HMAC are **not case-sensitive**. This means the signature
  string can be verified regardless of letter casing.
- **RSA:** Signatures generated using RSA are **case-sensitive**.
- **Ed25519:** Signatures generated using ED25519 are also **case-sensitive**

Please consult [SIGNED request example (HMAC)](#signed-request-example-hmac),
[SIGNED request example (RSA)](#signed-request-example-rsa), and
[SIGNED request example (Ed25519)](#signed-request-example-ed25519) on how to compute signature,
depending on which API key type you are using.

<a id="timingsecurity"></a>

### Timing security

- `SIGNED` requests also require a `timestamp` parameter which should be the current timestamp
  either in milliseconds or microseconds. (See [General API Information](#general-api-information))
- An additional optional parameter, `recvWindow`, specifies for how long the request stays valid and
  may only be specified in milliseconds.
  - `recvWindow` supports up to three decimal places of precision (e.g., 6000.346) so that
    microseconds may be specified.
  - If `recvWindow` is not sent, **it defaults to 5000 milliseconds**.
  - Maximum `recvWindow` is 60000 milliseconds.
- Request processing logic is as follows:

```javascript
serverTime = getCurrentTime()
if (timestamp < (serverTime + 1 second) && (serverTime - timestamp) <= recvWindow) {
  // begin processing request
  serverTime = getCurrentTime()
  if (serverTime - timestamp) <= recvWindow {
    // forward request to Matching Engine
  } else {
    // reject request
  }
  // finish processing request
} else {
  // reject request
}
```

**Serious trading is about timing.** Networks can be unstable and unreliable, which can lead to
requests taking varying amounts of time to reach the servers. With `recvWindow`, you can specify
that the request must be processed within a certain number of milliseconds or be rejected by the
server.

**It is recommended to use a small `recvWindow` of 5000 or less!**

### SIGNED request example (HMAC)

Here is a step-by-step guide on how to sign requests using an HMAC secret key.

Example API key and secret key:

| Key         | Value                                                              |
| ----------- | ------------------------------------------------------------------ |
| `apiKey`    | `vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A` |
| `secretKey` | `NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j` |

**WARNING: DO NOT SHARE YOUR API KEY AND SECRET KEY WITH ANYONE.**

The example keys are provided here only for illustrative purposes.

Example of request with a symbol name comprised entirely of ASCII characters:

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "BTCUSDT",
    "side": "SELL",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "0.01000000",
    "price": "52000.00",
    "recvWindow": 100,
    "timestamp": 1645423376532,
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
    "signature": "------ FILL ME ------"
  }
}
```

Example of a request with a symbol name containing non-ASCII characters:

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "１２３４５６",
    "side": "BUY",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "0.01000000",
    "price": "0.10000000",
    "recvWindow": 5000,
    "timestamp": 1645423376532,
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
    "signature": "------ FILL ME ------"
  }
}
```

As you can see, the `signature` parameter is currently missing.

**Step 1: Construct the signature payload**

Take all request `params` except `signature` and **sort them in alphabetical order by parameter
name**:

For the first set of example parameters (ASCII only):

| Parameter     | Value                                                            |
| ------------- | ---------------------------------------------------------------- |
| `apiKey`      | vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A |
| `price`       | 52000.00                                                         |
| `quantity`    | 0.01000000                                                       |
| `recvWindow`  | 100                                                              |
| `side`        | SELL                                                             |
| `symbol`      | BTCUSDT                                                          |
| `timeInForce` | GTC                                                              |
| `timestamp`   | 1645423376532                                                    |
| `type`        | LIMIT                                                            |

For the second set of example parameters (some non-ASCII characters):

| Parameter     | Value                                                            |
| ------------- | ---------------------------------------------------------------- |
| `apiKey`      | vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A |
| `price`       | 0.10000000                                                       |
| `quantity`    | 1.00000000                                                       |
| `recvWindow`  | 5000                                                             |
| `side`        | BUY                                                              |
| `symbol`      | １２３４５６                                                     |
| `timeInForce` | GTC                                                              |
| `timestamp`   | 1645423376532                                                    |
| `type`        | LIMIT                                                            |

Format parameters as `parameter=value` pairs separated by `&`. Values need to be encoded in UTF-8.

For the first set of example parameters (ASCII only), the signature payload should look like this:

```console
apiKey=vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A&price=52000.00&quantity=0.01000000&recvWindow=100&side=SELL&symbol=BTCUSDT&timeInForce=GTC&timestamp=1645423376532&type=LIMIT
```

For the second set of example parameters (some non-ASCII characters), the signature payload should
look like this:

```console
apiKey=vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A&price=0.10000000&quantity=1.00000000&recvWindow=5000&side=BUY&symbol=１２３４５６&timeInForce=GTC&timestamp=1645423376532&type=LIMIT
```

**Step 2: Compute the signature**

1. Use the `secretKey` of your API key as the signing key for the HMAC-SHA-256 algorithm.
2. Sign the UTF-8 bytes of the signature payload constructed in Step 1.
3. Encode the HMAC-SHA-256 output as a hex string.

Note that `apiKey`, `secretKey`, and the payload are **case-sensitive**, while the resulting
signature value is case-insensitive.

You can cross-check your signature algorithm implementation with OpenSSL:

For the first set of example parameters (ASCII only):

```console
$ echo -n 'apiKey=vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A&price=52000.00&quantity=0.01000000&recvWindow=100&side=SELL&symbol=BTCUSDT&timeInForce=GTC&timestamp=1645423376532&type=LIMIT' \
  | openssl dgst -hex -sha256 -hmac 'NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j'

aa1b5712c094bc4e57c05a1a5c1fd8d88dcd628338ea863fec7b88e59fe2db24
```

For the second set of example parameters (some non-ASCII characters):

```console
$ echo -n 'apiKey=vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A&price=0.10000000&quantity=1.00000000&recvWindow=5000&side=BUY&symbol=１２３４５６&timeInForce=GTC&timestamp=1645423376532&type=LIMIT' \
  | openssl dgst -hex -sha256 -hmac 'NhqPtmdSJYdKjVHjA7PZj4Mge3R5YNiP1e3UZjInClVN65XAbvqqM6A7H5fATj0j'

b33892ae8e687c939f4468c6268ddd4c40ac1af18ad19a064864c47bae0752cd
```

**Step 3: Add `signature` to request `params`**

Complete the request by adding the `signature` parameter with the signature string.

For the first set of example parameters (ASCII only):

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "BTCUSDT",
    "side": "SELL",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "0.01000000",
    "price": "52000.00",
    "recvWindow": 100,
    "timestamp": 1645423376532,
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
    "signature": "aa1b5712c094bc4e57c05a1a5c1fd8d88dcd628338ea863fec7b88e59fe2db24"
  }
}
```

For the second set of example parameters (some non-ASCII characters):

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "１２３４５６",
    "side": "BUY",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "1.00000000",
    "price": "0.10000000",
    "recvWindow": 5000,
    "timestamp": 1645423376532,
    "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
    "signature": "b33892ae8e687c939f4468c6268ddd4c40ac1af18ad19a064864c47bae0752cd"
  }
}
```

### SIGNED request example (RSA)

Here is a step-by-step guide on how to sign requests using an RSA private key.

| Key      | Value                                                              |
| -------- | ------------------------------------------------------------------ |
| `apiKey` | `CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ` |

These examples assume the private key is stored in the file `test-rsa-prv.pem`.

**WARNING: DO NOT SHARE YOUR API KEY AND PRIVATE KEY WITH ANYONE.**

The example keys are provided here only for illustrative purposes.

Example of request with a symbol name comprised entirely of ASCII characters:

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "BTCUSDT",
    "side": "SELL",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "0.01000000",
    "price": "52000.00",
    "recvWindow": 100,
    "timestamp": 1645423376532,
    "apiKey": "CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ",
    "signature": "------ FILL ME ------"
  }
}
```

Example of a request with a symbol name containing non-ASCII characters:

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "１２３４５６",
    "side": "BUY",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "0.01000000",
    "price": "0.10000000",
    "recvWindow": 5000,
    "timestamp": 1645423376532,
    "apiKey": "CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ",
    "signature": "------ FILL ME ------"
  }
}
```

**Step 1: Construct the signature payload**

Take all request `params` except `signature` and **sort them in alphabetical order by parameter
name**:

For the first set of example parameters (ASCII only):

| Parameter     | Value                                                            |
| ------------- | ---------------------------------------------------------------- |
| `apiKey`      | CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ |
| `price`       | 52000.00                                                         |
| `quantity`    | 0.01000000                                                       |
| `recvWindow`  | 100                                                              |
| `side`        | SELL                                                             |
| `symbol`      | BTCUSDT                                                          |
| `timeInForce` | GTC                                                              |
| `timestamp`   | 1645423376532                                                    |
| `type`        | LIMIT                                                            |

For the second set of example parameters (some non-ASCII characters):

| Parameter     | Value                                                            |
| ------------- | ---------------------------------------------------------------- |
| `apiKey`      | CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ |
| `price`       | 0.10000000                                                       |
| `quantity`    | 1.00000000                                                       |
| `recvWindow`  | 5000                                                             |
| `side`        | BUY                                                              |
| `symbol`      | １２３４５６                                                     |
| `timeInForce` | GTC                                                              |
| `timestamp`   | 1645423376532                                                    |
| `type`        | LIMIT                                                            |

Format parameters as `parameter=value` pairs separated by `&`. Values need to be encoded in UTF-8.

For the first set of example parameters (ASCII only), the signature payload should look like this:

```console
apiKey=CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ&price=52000.00&quantity=0.01000000&recvWindow=100&side=SELL&symbol=BTCUSDT&timeInForce=GTC&timestamp=1645423376532&type=LIMIT
```

For the second set of example parameters (some non-ASCII characters), the signature payload should
look like this:

```console
apiKey=CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ&price=0.10000000&quantity=1.00000000&recvWindow=5000&side=BUY&symbol=１２３４５６&timeInForce=GTC&timestamp=1645423376532&type=LIMIT
```

**Step 2: Compute the signature**

1. Sign the UTF-8 bytes of the signature payload constructed in Step 1 using the RSASSA-PKCS1-v1_5
   algorithm with SHA-256 hash function.
2. Encode the output in base64.

Note that `apiKey`, the payload, and the resulting `signature` are **case-sensitive**.

You can cross-check your signature algorithm implementation with OpenSSL:

For the first set of example parameters (ASCII only):

```console
$ echo -n 'apiKey=CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ&price=52000.00&quantity=0.01000000&recvWindow=100&side=SELL&symbol=BTCUSDT&timeInForce=GTC&timestamp=1645423376532&type=LIMIT' \
  | openssl dgst -sha256 -sign test-rsa-prv.pem \
  | openssl enc -base64 -A

OJJaf8C/3VGrU4ATTR4GiUDqL2FboSE1Qw7UnnoYNfXTXHubIl1iaePGuGyfct4NPu5oVEZCH4Q6ZStfB1w4ssgu0uiB/Bg+fBrRFfVgVaLKBdYHMvT+ljUJzqVaeoThG9oXlduiw8PbS9U8DYAbDvWN3jqZLo4Z2YJbyovyDAvDTr/oC0+vssLqP7NmlNb3fF3Bj7StmOwJvQJTbRAtzxK5PP7OQe+0mbW+D7RqVkUiSswR8qJFWTeSe4nXXNIdZdueYhF/Xf25L+KitJS5IHdIHcKfEw3MQzHFb2ZsGWkjDQwxkwr7Noi0Zaa+gFtxCuatGFm9dFIyx217pmSHtA==
```

For the second set of example parameters (some non-ASCII characters):

```console
$ echo -n 'apiKey=CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ&price=0.10000000&quantity=1.00000000&recvWindow=5000&side=BUY&symbol=１２３４５６&timeInForce=GTC&timestamp=1645423376532&type=LIMIT' \
  | openssl dgst -sha256 -sign test-rsa-prv.pem \
  | openssl enc -base64 -A

F3o/79Ttvl2cVYGPfBOF3oEOcm5QcYmTYWpdVIrKve5u+8paMNDAdUE+teqMxFM9HcquetGcfuFpLYtsQames5bDx/tskGM76TWW8HaM+6tuSYBSFLrKqChfA9hQGLYGjAiflf1YBnDhY+7vNbJFusUborNOloOj+ufzP5q42PvI3H0uNy3W5V3pyfXpDGCBtfCYYr9NAqA4d+AQfyllL/zkO9h9JSdozN49t0/hWGoD2dWgSO0Je6MytKEvD4DQXGeqNlBTB6tUXcWnRW+FcaKZ4KYqnxCtb1u8rFXUYgFykr2CbcJLSmw6ydEJ3EZ/NaZopRr+cU0W2m0HZ3qucw==
```

**Step 3: Add `signature` to request `params`**

Complete the request by adding the `signature` parameter with the signature string.

For the first set of example parameters (ASCII only):

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "BTCUSDT",
    "side": "SELL",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "0.01000000",
    "price": "52000.00",
    "newOrderRespType": "ACK",
    "recvWindow": 100,
    "timestamp": 1645423376532,
    "apiKey": "CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ",
    "signature": "OJJaf8C/3VGrU4ATTR4GiUDqL2FboSE1Qw7UnnoYNfXTXHubIl1iaePGuGyfct4NPu5oVEZCH4Q6ZStfB1w4ssgu0uiB/Bg+fBrRFfVgVaLKBdYHMvT+ljUJzqVaeoThG9oXlduiw8PbS9U8DYAbDvWN3jqZLo4Z2YJbyovyDAvDTr/oC0+vssLqP7NmlNb3fF3Bj7StmOwJvQJTbRAtzxK5PP7OQe+0mbW+D7RqVkUiSswR8qJFWTeSe4nXXNIdZdueYhF/Xf25L+KitJS5IHdIHcKfEw3MQzHFb2ZsGWkjDQwxkwr7Noi0Zaa+gFtxCuatGFm9dFIyx217pmSHtA=="
  }
}
```

For the second set of example parameters (some non-ASCII characters):

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "１２３４５６",
    "side": "SELL",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "1.00000000",
    "price": "0.10000000",
    "recvWindow": 5000,
    "timestamp": 1645423376532,
    "apiKey": "CAvIjXy3F44yW6Pou5k8Dy1swsYDWJZLeoK2r8G4cFDnE9nosRppc2eKc1T8TRTQ",
    "signature": "F3o/79Ttvl2cVYGPfBOF3oEOcm5QcYmTYWpdVIrKve5u+8paMNDAdUE+teqMxFM9HcquetGcfuFpLYtsQames5bDx/tskGM76TWW8HaM+6tuSYBSFLrKqChfA9hQGLYGjAiflf1YBnDhY+7vNbJFusUborNOloOj+ufzP5q42PvI3H0uNy3W5V3pyfXpDGCBtfCYYr9NAqA4d+AQfyllL/zkO9h9JSdozN49t0/hWGoD2dWgSO0Je6MytKEvD4DQXGeqNlBTB6tUXcWnRW+FcaKZ4KYqnxCtb1u8rFXUYgFykr2CbcJLSmw6ydEJ3EZ/NaZopRr+cU0W2m0HZ3qucw=="
  }
}
```

### SIGNED Request Example (Ed25519)

**Note: It is highly recommended to use Ed25519 API keys as they will provide the best performance
and security out of all supported key types.**

Here is a step-by-step guide on how to sign requests using an Ed25519 private key.

| Key      | Value                                                              |
| -------- | ------------------------------------------------------------------ |
| `apiKey` | `4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO` |

These examples assume the private key is stored in the file `test-ed25519-prv.pem`.

**WARNING: DO NOT SHARE YOUR API KEY AND PRIVATE KEY WITH ANYONE.**

The example keys are provided here only for illustrative purposes.

Example of request with a symbol name comprised entirely of ASCII characters:

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "BTCUSDT",
    "side": "SELL",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "0.01000000",
    "price": "52000.00",
    "recvWindow": 100,
    "timestamp": 1645423376532,
    "apiKey": "4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO",
    "signature": "------ FILL ME ------"
  }
}
```

Example of a request with a symbol name containing non-ASCII characters:

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "１２３４５６",
    "side": "BUY",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "0.01000000",
    "price": "0.10000000",
    "recvWindow": 5000,
    "timestamp": 1645423376532,
    "apiKey": "4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO",
    "signature": "------ FILL ME ------"
  }
}
```

**Step 1: Construct the signature payload**

Take all request `params` except `signature` and **sort them in alphabetical order by parameter
name**:

For the first set of example parameters (ASCII only):

| Parameter     | Value                                                            |
| ------------- | ---------------------------------------------------------------- |
| `apiKey`      | 4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO |
| `price`       | 52000.00                                                         |
| `quantity`    | 0.01000000                                                       |
| `recvWindow`  | 100                                                              |
| `side`        | SELL                                                             |
| `symbol`      | BTCUSDT                                                          |
| `timeInForce` | GTC                                                              |
| `timestamp`   | 1645423376532                                                    |
| `type`        | LIMIT                                                            |

For the second set of example parameters (some non-ASCII characters):

| Parameter     | Value                                                            |
| ------------- | ---------------------------------------------------------------- |
| `apiKey`      | 4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO |
| `price`       | 0.20000000                                                       |
| `quantity`    | 1.00000000                                                       |
| `recvWindow`  | 5000                                                             |
| `side`        | SELL                                                             |
| `symbol`      | １２３４５６                                                     |
| `timeInForce` | GTC                                                              |
| `timestamp`   | 1668481559918                                                    |
| `type`        | LIMIT                                                            |

Format parameters as `parameter=value` pairs separated by `&`. Values need to be encoded in UTF-8.

For the first set of example parameters (ASCII only), the signature payload should look like this:

```console
apiKey=4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO&price=52000.00&quantity=0.01000000&recvWindow=100&side=SELL&symbol=BTCUSDT&timeInForce=GTC&timestamp=1645423376532&type=LIMIT
```

For the second set of example parameters (some non-ASCII characters), the signature payload should
look like this:

```console
apiKey=4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO&price=0.10000000&quantity=1.00000000&recvWindow=5000&side=BUY&symbol=１２３４５６&timeInForce=GTC&timestamp=1645423376532&type=LIMIT
```

**Step 2: Compute the signature**

1. Sign the UTF-8 bytes of your signature payload constructed in Step 1 using the Ed25519 private
   key.
2. Encode the output in base64.

Note that `apiKey`, the payload, and the resulting `signature` are **case-sensitive**.

You can cross-check your signature algorithm implementation with OpenSSL:

For the first set of example parameters (ASCII only):

```console
echo -n "apiKey=4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO&price=52000.00&quantity=0.01000000&recvWindow=100&side=SELL&symbol=BTCUSDT&timeInForce=GTC&timestamp=1645423376532&type=LIMIT" \
  | openssl dgst -sign ./test-ed25519-prv.pem \
  | openssl enc -base64 -A

EocljwPl29jDxWYaaRaOo4pJ9wEblFbklJvPugNscLLuKd5vHM2grWjn1z+rY0aJ7r/44enxHL6mOAJuJ1kqCg==
```

For the second set of example parameters (some non-ASCII characters):

```console
echo -n "apiKey=4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO&price=0.10000000&quantity=1.00000000&recvWindow=5000&side=BUY&symbol=１２３４５６&timeInForce=GTC&timestamp=1645423376532&type=LIMIT" \
  | openssl dgst -sign ./test-ed25519-prv.pem \
  | openssl enc -base64 -A

dtNHJeyKry+cNjiGv+sv5kynO9S40tf8k7D5CfAEQAp0s2scunZj+ovJdz2OgW8XhkB9G3/HmASkA9uY9eyFCA==
```

**Step 3: Add the signature to request `params`**

For the first set of example parameters (ASCII only):

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "BTCUSDT",
    "side": "SELL",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "0.01000000",
    "price": "52000.00",
    "newOrderRespType": "ACK",
    "recvWindow": 100,
    "timestamp": 1645423376532,
    "apiKey": "4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO",
    "signature": "EocljwPl29jDxWYaaRaOo4pJ9wEblFbklJvPugNscLLuKd5vHM2grWjn1z+rY0aJ7r/44enxHL6mOAJuJ1kqCg=="
  }
}
```

For the second set of example parameters (some non-ASCII characters):

```json
{
  "id": "4885f793-e5ad-4c3b-8f6c-55d891472b71",
  "method": "order.place",
  "params": {
    "symbol": "１２３４５６",
    "side": "SELL",
    "type": "LIMIT",
    "timeInForce": "GTC",
    "quantity": "1.00000000",
    "price": "0.10000000",
    "recvWindow": 5000,
    "timestamp": 1645423376532,
    "apiKey": "4yNzx3yWC5bS6YTwEkSRaC0nRmSQIIStAUOh1b6kqaBrTLIhjCpI5lJH8q8R8WNO",
    "signature": "dtNHJeyKry+cNjiGv+sv5kynO9S40tf8k7D5CfAEQAp0s2scunZj+ovJdz2OgW8XhkB9G3/HmASkA9uY9eyFCA=="
  }
}
```

Here is a sample Python script performing all the steps above:

```python
#!/usr/bin/env python3

import base64
import time
import json
from cryptography.hazmat.primitives.serialization import load_pem_private_key
from websocket import create_connection

# Set up authentication
API_KEY='put your own API Key here'
PRIVATE_KEY_PATH='test-prv-key.pem'

# Load the private key.
# In this example the key is expected to be stored without encryption,
# but we recommend using a strong password for improved security.
with open(PRIVATE_KEY_PATH, 'rb') as f:
  private_key = load_pem_private_key(data=f.read(), password=None)

# Set up the request parameters
params = {
    'apiKey':       API_KEY,
    'symbol':       '１２３４５６',
    'side':         'SELL',
    'type':         'LIMIT',
    'timeInForce':  'GTC',
    'quantity':     '1.0000000',
    'price':        '0.10000000',
    'recvWindow':   5000
}

# Timestamp the request
timestamp = int(time.time() * 1000) # UNIX timestamp in milliseconds
params['timestamp'] = timestamp

# Sort parameters alphabetically by name
params = dict(sorted(params.items()))

# Compute the signature payload
payload = '&'.join([f"{k}={v}" for k,v in params.items()]) # no percent encoding here!

# Sign the request
signature = base64.b64encode(private_key.sign(payload.encode('UTF-8')))
params['signature'] = signature.decode('ASCII')

# Send the request
request = {
    'id': 'my_new_order',
    'method': 'order.place',
    'params': params
}

ws = create_connection("wss://ws-api.binance.com:443/ws-api/v3")
ws.send(json.dumps(request))
result =  ws.recv()
ws.close()

print(result)
```

## Session Authentication

**Note:** Only _Ed25519_ keys are supported for this feature.

If you do not want to specify `apiKey` and `signature` in each individual request, you can
authenticate your API key for the active WebSocket session.

Once authenticated, you no longer have to specify `apiKey` and `signature` for those requests that
need them. Requests will be performed on behalf of the account owning the authenticated API key.

**Note:** You still have to specify the `timestamp` parameter for `SIGNED` requests.

### Authenticate after connection

You can authenticate an already established connection using session authentication requests:

- [`session.logon`](web-socket-api.md#log-in-with-api-key-user_data) –
  authenticate, or change the API key associated with the connection
- [`session.status`](web-socket-api.md#query-session-status) – check
  connection status and the current API key
- [`session.logout`](web-socket-api.md#log-out-of-the-session) – forget the
  API key associated with the connection

**Regarding API key revocation:**

If during an active session the API key becomes invalid for _any reason_ (e.g. IP address is not
whitelisted, API key was deleted, API key doesn't have correct permissions, etc), after the next
request the session will be revoked with the following error message:

```javascript
{
    "id": null,
    "status": 401,
    "error": {
        "code": -2015,
        "msg": "Invalid API-key, IP, or permissions for action."
    }
}
```

### Authorize _ad hoc_ requests

Only one API key can be authenticated with the WebSocket connection. The authenticated API key is
used by default for requests that require an `apiKey` parameter. However, you can always specify the
`apiKey` and `signature` explicitly for individual requests, overriding the authenticated API key
and using a different one to authorize a specific request.

For example, you might want to authenticate your `USER_DATA` key to be used by default, but specify
the `TRADE` key with an explicit signature when placing orders.

## Data sources

- The API system is asynchronous. Some delay in the response is normal and expected.

- Each method has a data source indicating where the data is coming from, and thus how up-to-date it
  is.

| Data Source     | Latency  | Description                                                      |
| --------------- | -------- | ---------------------------------------------------------------- |
| Matching Engine | lowest   | The Matching Engine produces the response directly               |
| Memory          | low      | Data is fetched from API server's local or external memory cache |
| Database        | moderate | Data is retrieved from the database                              |

- Some methods have more than one data source (e.g., Memory => Database).

  This means that the API will look for the latest data in that order: first in the cache, then in
  the database.

# Public API requests

## General requests

<a id="ping"></a>

### Test connectivity

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "ping"
}
```
Test connectivity to the WebSocket API.

Note: You can use regular WebSocket ping frames to test connectivity as well, WebSocket API will respond with pong frames as soon as possible. ping request along with time is a safe way to test request-response handling in your application.

**Weight:**
1

**Parameters:**
NONE

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "922bcc6e-9de8-440d-9e84-7c80933a8d0d",
    "status": 200,
    "result": {},
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

<a id="time"></a>

### Check server time

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "time"
}
```
Test connectivity to the WebSocket API and get the current server time.

**Weight:**
1

**Parameters:**
NONE

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "187d3cb2-942d-484c-8271-4e2141bbadb1",
    "status": 200,
    "result": {
        "serverTime": 1656400526260
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

<a id="exchangeInfo"></a>
<a id="exchange-info"></a>
<a id="exchangeinfo"></a>

### Exchange information

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "exchangeInfo"
}
```
Query current exchange trading rules, rate limits, and symbol
information.

**Weight:**
20

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | NO | Describe a single symbol
`symbols` | ARRAY OF STRING | NO | Describe multiple symbols
`permissions` | ARRAY OF STRING | NO | Filter symbols by permissions
`showPermissionSets` | BOOLEAN | NO | Controls whether the content of the `permissionSets` field is populated or not. Defaults to `true`.
`symbolStatus` | ENUM | NO | Filters for symbols that have this `tradingStatus`. Valid values: `TRADING`, `HALT`, `BREAK`. Cannot be used in combination with `symbol` or `symbols`.

**Data Source:** Memory

**Notes:**
* If the value provided to `symbol` or `symbols` do not exist, the endpoint will throw an error saying the symbol is invalid.
* All parameters are optional.
* Only one of `symbol`, `symbols`, `permissions` parameters can be specified.
* Without parameters, `exchangeInfo` displays all symbols with `["SPOT", "MARGIN", "LEVERAGED"]` permissions.
  * In order to list *all* active symbols on the exchange, you need to explicitly request all permissions.
* `permissions` accepts either a list of permissions, or a single permission name. E.g. `"SPOT"`.

<a id="examples-of-symbol-permissions-interpretation-from-the-response"></a>

**Examples of Symbol Permissions Interpretation from the Response:**

* `[["A","B"]]` means you may place an order if your account has either permission "A" **or** permission "B".
* `[["A"],["B"]]` means you can place an order if your account has permission "A" **and** permission "B".
* `[["A"],["B","C"]]` means you can place an order if your account has permission "A" **and** permission "B" or permission "C". (Inclusive or is applied here, not exclusive or, so your account may have both permission "B" and permission "C".)

**Response:**
```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "status": 200,
    "result": {
        "timezone": "UTC",
        "serverTime": 1655969291181,
        // Global rate limits. See "Rate limits" section.
        "rateLimits": [
            {
                "rateLimitType": "REQUEST_WEIGHT", // Rate limit type: REQUEST_WEIGHT, ORDERS, CONNECTIONS
                "interval": "MINUTE",              // Rate limit interval: SECOND, MINUTE, DAY
                "intervalNum": 1,                  // Rate limit interval multiplier (i.e., "1 minute")
                "limit": 6000                      // Rate limit per interval
            },
            {
                "rateLimitType": "ORDERS",
                "interval": "SECOND",
                "intervalNum": 10,
                "limit": 50
            },
            {
                "rateLimitType": "ORDERS",
                "interval": "DAY",
                "intervalNum": 1,
                "limit": 160000
            },
            {
                "rateLimitType": "CONNECTIONS",
                "interval": "MINUTE",
                "intervalNum": 5,
                "limit": 300
            }
        ],
        // Exchange filters are explained on the "Filters" page:
        // https://github.com/binance/binance-spot-api-docs/blob/master/filters.md
        // All exchange filters are optional.
        "exchangeFilters": [
            {
                "filterType": "EXCHANGE_MAX_NUM_ORDERS",
                "maxNumOrders": 1000
            }
        ],
        "symbols": [
            {
                "symbol": "BNBBTC",
                "status": "TRADING",
                "baseAsset": "BNB",
                "baseAssetPrecision": 8,
                "quoteAsset": "BTC",
                "quotePrecision": 8,
                "quoteAssetPrecision": 8,
                "baseCommissionPrecision": 8,
                "quoteCommissionPrecision": 8,
                "orderTypes": [
                    "LIMIT",
                    "LIMIT_MAKER",
                    "MARKET",
                    "STOP_LOSS_LIMIT",
                    "TAKE_PROFIT_LIMIT"
                ],
                "icebergAllowed": true,
                "ocoAllowed": true,
                "otoAllowed": true,
                "opoAllowed": true,
                "quoteOrderQtyMarketAllowed": true,
                "allowTrailingStop": true,
                "cancelReplaceAllowed": true,
                "amendAllowed": false,
                "pegInstructionsAllowed": true,
                "isSpotTradingAllowed": true,
                "isMarginTradingAllowed": true,
                // Symbol filters are explained on the "Filters" page:
                // https://github.com/binance/binance-spot-api-docs/blob/master/filters.md
                // All symbol filters are optional.
                "filters": [
                    {
                        "filterType": "PRICE_FILTER",
                        "minPrice": "0.00000100",
                        "maxPrice": "100000.00000000",
                        "tickSize": "0.00000100"
                    },
                    {
                        "filterType": "LOT_SIZE",
                        "minQty": "0.00100000",
                        "maxQty": "100000.00000000",
                        "stepSize": "0.00100000"
                    }
                ],
                "permissions": [
                    "SPOT"
                ],
                "permissionSets": [
                    [
                        "SPOT",
                        "MARGIN",
                        "TRD_GRP_004"
                    ]
                ],
                "defaultSelfTradePreventionMode": "NONE",
                "allowedSelfTradePreventionModes": [
                    "NONE"
                ]
            }
        ],
        // Optional field. Present only when SOR is available.
        // https://github.com/binance/binance-spot-api-docs/blob/master/faqs/sor_faq.md
        "sors": [
            {
                "baseAsset": "BTC",
                "symbols": [
                    "BTCUSDT",
                    "BTCUSDC"
                ]
            }
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

<a id="executionRules"></a>
<a id="execution-rules"></a>
<a id="executionrules"></a>

### Query Execution Rules

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "executionRules"
}
```
Query execution rules for symbols.

**Weight:**
Parameter | Weight
--- | ---
`symbol` | 2
`symbols` | 2 for each `symbol`, capped at a max of 40
`symbolStatus` | 40
None | 40

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | NO | Query for specified symbol.
`symbols` | ARRAY OF STRING | NO | Query for multiple symbols.
`symbolStatus` | ENUM | NO | Query for all symbols with the specified status. Supported values: `TRADING`, `HALT`, `BREAK`

**Data Source:** Memory

**Note:** No combination of multiple parameters is allowed.

**Response:**
```javascript
{
    "id": "5162affb-0aba-4821-b475-f2625006eb43",
    "status": 200,
    "result": {
        "symbolRules": [
            {
                "symbol": "BAZUSD",
                "rules": [
                    {
                        "ruleType": "PRICE_RANGE",
                        "bidLimitMultUp": "1.0001",
                        "bidLimitMultDown": "0.9999",
                        "askLimitMultUp": "1.0001",
                        "askLimitMultDown": "0.9999"
                    }
                ]
            }
        ]
    }
}
```

## Market data requests

<a id="depth"></a>

### Order book

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "depth",
    "params": {
        "symbol": "BNBUSDT"
    }
}
```
Get current order book.

Note that this request returns limited market depth.

If you need to continuously monitor order book updates, please consider using WebSocket Streams:
  * `<symbol>@depth<levels>`
  * `<symbol>@depth`

You can use `depth` request together with `<symbol>@depth` streams to [maintain a local order book](web-socket-streams.md#how-to-manage-a-local-order-book-correctly).

**Weight:**
Adjusted based on the limit:

|Limit|Request Weight
------|-------
1-100|  5
101-500| 25
501-1000| 50
1001-5000| 250

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |
`limit` | INT | NO | Default: 100; Maximum: 5000.
`symbolStatus` | ENUM | NO | Filters for symbols that have this `tradingStatus`. <br/> A status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`.

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "51e2affb-0aba-4821-ba75-f2625006eb43",
    "status": 200,
    "result": {
        "lastUpdateId": 2731179239,
        // Bid orders. Each entry is [price, quantity].
        "bids": [
            [
                "0.01379900", // Price
                "3.43200000"  // Quantity
            ],
            [
                "0.01379800", // Price
                "3.24300000"  // Quantity
            ],
            [
                "0.01379700", // Price
                "10.45500000" // Quantity
            ],
            [
                "0.01379600", // Price
                "3.82100000"  // Quantity
            ],
            [
                "0.01379500", // Price
                "10.26200000" // Quantity
            ]
        ],
        // Ask orders. Each entry is [price, quantity].
        "asks": [
            [
                "0.01380000", // Price
                "5.91700000"  // Quantity
            ],
            [
                "0.01380100", // Price
                "6.01400000"  // Quantity
            ],
            [
                "0.01380200", // Price
                "0.26800000"  // Quantity
            ],
            [
                "0.01380300", // Price
                "0.33800000"  // Quantity
            ],
            [
                "0.01380400", // Price
                "0.26800000"  // Quantity
            ]
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

<a id="trades.recent"></a>
<a id="trades-recent"></a>

### Recent trades

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "trades.recent",
    "params": {
        "symbol": "BNBUSDT"
    }
}
```
Get recent trades.

If you need access to real-time trading activity, please consider using
WebSocket Streams:

* `<symbol>@trade`

**Weight:**
25

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |
`limit` | INT | NO | Default: 500; Maximum: 1000.

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "409a20bd-253d-41db-a6dd-687862a5882f",
    "status": 200,
    "result": [
        {
            "id": 194686783,
            "price": "0.01361000",
            "qty": "0.01400000",
            "quoteQty": "0.00019054",
            "time": 1660009530807,
            "isBuyerMaker": true,
            "isBestMatch": true
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 25
        }
    ]
}
```

<a id="trades.historical"></a>
<a id="trades-historical"></a>

### Historical trades

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "trades.historical",
    "params": {
        "symbol": "BNBUSDT"
    }
}
```
Get historical trades.

**Weight:**
25

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |
`fromId` | LONG | NO | Trade ID to begin at
`limit` | INT | NO | Default: 500; Maximum: 1000.

**Data Source:** Database

Notes:

* If `fromId` is not specified, the most recent trades are returned.

**Response:**
```javascript
{
    "id": "cffc9c7d-4efc-4ce0-b587-6b87448f052a",
    "status": 200,
    "result": [
        {
            "id": 0,
            "price": "0.00005000",
            "qty": "40.00000000",
            "quoteQty": "0.00200000",
            "time": 1500004800376,
            "isBuyerMaker": true,
            "isBestMatch": true
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 25
        }
    ]
}
```

<a id="blockTrades.historical"></a>
<a id="blockTrades-historical"></a>
<a id="block-trades-historical"></a>
<a id="blocktrades-historical"></a>
<a id="historicalBlockTrades"></a>

### Historical Block Trades

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "blockTrades.historical",
    "params": {
        "symbol": "BNBBTC",
        "fromId": 582
    }
}
```
Get block trades.

**Weight:**
25

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |
`fromId` | LONG | YES | Block trade ID to fetch from
`limit` | LONG | NO | Default: 500; Maximum: 1000

**Data Source:** Database

**Response:**
```javascript
{
    "id": "cffc9c7d-4efc-4ce0-b587-6b87448f052a",
    "status": 200,
    "result": [
        {
            "id": 582,
            "price": "0.052",
            "qty": "5838",
            "quoteQty": "303.576",
            "time": 1772506983321,
            "isBuyerMaker": true
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 10
        }
    ]
}
```

<a id="trades.aggregate"></a>
<a id="trades-aggregate"></a>

### Aggregate trades

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "trades.aggregate",
    "params": {
        "symbol": "BNBUSDT"
    }
}
```
Get aggregate trades.

An *aggregate trade* (aggtrade) represents one or more individual
trades.

Trades that fill at the same time, from the same taker order, with the
same price –

those trades are collected into an aggregate trade with total quantity
of the individual trades.

If you need access to real-time trading activity, please consider using
WebSocket Streams:

* `<symbol>@aggTrade`

If you need historical aggregate trade data, please consider using [data.binance.vision](https://github.com/binance/binance-public-data/#aggtrades).

**Weight:**
4

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |
`fromId` | LONG | NO | Aggregate trade ID to begin at
`startTime` | LONG | NO | Timestamp in ms to get aggregate trades from INCLUSIVE.
`endTime` | LONG | NO | Timestamp in ms to get aggregate trades until INCLUSIVE.
`limit` | INT | NO | Default: 500; Maximum: 1000.

**Data Source:** Database

- If `fromId` is specified, return aggtrades with aggregate trade ID >= `fromId`. Use `fromId` and `limit` to page through all aggtrades.
- If `startTime` and/or `endTime` are specified, aggtrades are filtered by execution time (`T`). `fromId` cannot be used together with `startTime` and `endTime`.
- If no condition is specified, the most recent aggregate trades are returned.

**Response:**
```javascript
{
    "id": "189da436-d4bd-48ca-9f95-9f613d621717",
    "status": 200,
    "result": [
        {
            "a": 50000000,      // Aggregate tradeId
            "p": "0.00274100",  // Price
            "q": "57.19000000", // Quantity
            "f": 59120167,      // First tradeId
            "l": 59120170,      // Last tradeId
            "T": 1565877971222, // Timestamp
            "m": true,          // Was the buyer the maker?
            "M": true           // Was the trade the best price match?
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

<a id="klines"></a>

### Klines

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "klines",
    "params": {
        "symbol": "BNBUSDT",
        "interval": "1s"
    }
}
```
Get klines (candlestick bars).

Klines are uniquely identified by their open & close time.

If you need access to real-time kline updates, please consider using WebSocket Streams:
  * `<symbol>@kline_<interval>`

If you need historical kline data, please consider using [data.binance.vision](https://github.com/binance/binance-public-data/#klines).

**Weight:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |
`interval` | ENUM | YES |
`startTime` | LONG | NO |
`endTime` | LONG | NO |
`timeZone` | STRING | NO | Default: 0 (UTC)
`limit` | INT | NO | Default: 500; Maximum: 1000.

**Data Source:** Database

<a id="kline-intervals"></a>

Supported kline intervals (case-sensitive):

Interval  | `interval` value
--------- | ----------------
seconds   | `1s`
minutes   | `1m`, `3m`, `5m`, `15m`, `30m`
hours     | `1h`, `2h`, `4h`, `6h`, `8h`, `12h`
days      | `1d`, `3d`
weeks     | `1w`
months    | `1M`

**Notes:**

* If `startTime` and `endTime` are not sent, the most recent klines are returned.
* Supported values for `timeZone`:
  * Hours and minutes (e.g. `-1:00`, `05:45`)
  * Only hours (e.g. `0`, `8`, `4`)
  * Accepted range is strictly [-12:00 to +14:00] inclusive
* If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC.
* Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`.

**Response:**
```javascript
{
    "id": "1dbbeb56-8eea-466a-8f6e-86bdcfa2fc0b",
    "status": 200,
    "result": [
        [
            1499040000000,     // Open time
            "0.01634790",      // Open
            "0.80000000",      // High
            "0.01575800",      // Low
            "0.01577100",      // Close
            "148976.11427815", // Volume
            1499644799999,     // Close time
            "2434.19055334",   // Quote asset volume
            308,               // Number of trades
            "1756.87402397",   // Taker buy base asset volume
            "28.46694368",     // Taker buy quote asset volume
            "0"                // Ignore
        ]
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

<a id="uiKlines"></a>
<a id="ui-klines"></a>
<a id="uiklines"></a>

### UI Klines

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "uiKlines",
    "params": {
        "symbol": "BNBUSDT",
        "interval": "1s"
    }
}
```
Get klines (candlestick bars) optimized for presentation.

This request is similar to `klines`, having the same parameters and response. `uiKlines` return modified kline data, optimized for presentation of candlestick charts.

**Weight:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |
`interval` | ENUM | YES |
`startTime` | LONG | NO |
`endTime` | LONG | NO |
`timeZone` | STRING | NO | Default: 0 (UTC)
`limit` | INT | NO | Default: 500; Maximum: 1000.

**Data Source:** Database

- If `startTime` and `endTime` are not sent, the most recent klines are returned.
- Supported values for `timeZone`:
  - Hours and minutes (e.g. `-1:00`, `05:45`)
  - Only hours (e.g. `0`, `8`, `4`)
  - Accepted range is strictly [-12:00 to +14:00] inclusive
- If `timeZone` provided, kline intervals are interpreted in that timezone instead of UTC.
- Note that `startTime` and `endTime` are always interpreted in UTC, regardless of `timeZone`.

**Response:**
```javascript
{
    "id": "b137468a-fb20-4c06-bd6b-625148eec958",
    "status": 200,
    "result": [
        [
            1499040000000,     // Open time
            "0.01634790",      // Open
            "0.80000000",      // High
            "0.01575800",      // Low
            "0.01577100",      // Close
            "148976.11427815", // Volume
            1499644799999,     // Close time
            "2434.19055334",   // Quote asset volume
            308,               // Number of trades
            "1756.87402397",   // Taker buy base asset volume
            "28.46694368",     // Taker buy quote asset volume
            "0"                // Ignore
        ]
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

<a id="avgPrice"></a>
<a id="avg-price"></a>
<a id="avgprice"></a>

### Current average price

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "avgPrice",
    "params": {
        "symbol": "BNBUSDT"
    }
}
```
Get current average price for a symbol.

**Weight:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "ddbfb65f-9ebf-42ec-8240-8f0f91de0867",
    "status": 200,
    "result": {
        "mins": 5,                 // Average price interval (in minutes)
        "price": "0.01378135",     // Average price
        "closeTime": 1694061154503 // Last trade time
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

<a id="ticker.24hr"></a>
<a id="ticker-24hr"></a>
<a id="twentyfourhourticker"></a>

### 24hr ticker price change statistics

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "ticker.24hr"
}
```
Get 24-hour rolling window price change statistics.

If you need to continuously monitor trading statistics, please consider using WebSocket Streams:

* [`<symbol>@ticker`](web-socket-streams.md#individual-symbol-ticker-streams) or `!ticker@arr`

* [`<symbol>@miniTicker`](web-socket-streams.md#individual-symbol-mini-ticker-stream) or [`!miniTicker@arr`](web-socket-streams.md#all-market-mini-tickers-stream)

If you need different window sizes,

use the [`ticker`](web-socket-api.md#rolling-window-price-change-statistics) request.

**Weight:**
Adjusted based on the number of requested symbols:

|Parameter|Symbols Provided|Weight|
|---|---|---|
|symbol| 1 |2|
| |omitted| 80|
|symbols| 1-20 |2|
| | 21-100 |40|
| | 101+ |80|
| |omitted| 80|

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | NO |
`symbols` | ARRAY OF STRING | NO |
`type` | ENUM | NO | Ticker type. Supported values: FULL (default) or MINI
`symbolStatus` | ENUM | NO | Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK`

**Data Source:** Memory

Notes:

* `symbol` and `symbols` cannot be used together.

* If no symbol is specified, returns information about all symbols currently trading on the exchange.

**Response:**

`FULL` type, for a single symbol:

```javascript
{
    "id": "9fa2a91b-3fca-4ed7-a9ad-58e3b67483de",
    "status": 200,
    "result": {
        "symbol": "BNBBTC",            // Symbol Name
        "priceChange": "0.00013900",
        "priceChangePercent": "1.020",
        "weightedAvgPrice": "0.01382453",
        "prevClosePrice": "0.01362800",
        "lastPrice": "0.01376700",     // Closing price of the interval
        "lastQty": "1.78800000",
        "bidPrice": "0.01376700",
        "bidQty": "4.64600000",
        "askPrice": "0.01376800",
        "askQty": "14.31400000",
        "openPrice": "0.01362800",     // Opening price of the Interval
        "highPrice": "0.01414900",     // Highest price in the interval
        "lowPrice": "0.01346600",      // Lowest  price in the interval
        "volume": "69412.40500000",    // Total trade volume (in base asset)
        "quoteVolume": "959.59411487", // Total trade volume (in quote asset)
        "openTime": 1660014164909,     // Start of the ticker interval
        "closeTime": 1660100564909,    // End of the ticker interval
        "firstId": 194696115,          // First tradeId
        "lastId": 194968287,           // Last tradeId
        "count": 272173                // Trade count
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

`MINI` type, for a single symbol:

```javascript
{
    "id": "9fa2a91b-3fca-4ed7-a9ad-58e3b67483de",
    "status": 200,
    "result": {
        "symbol": "BNBBTC",            // Symbol Name
        "openPrice": "0.01362800",     // Opening price of the Interval
        "highPrice": "0.01414900",     // Highest price in the interval
        "lowPrice": "0.01346600",      // Lowest  price in the interval
        "lastPrice": "0.01376700",     // Closing price of the interval
        "volume": "69412.40500000",    // Total trade volume (in base asset)
        "quoteVolume": "959.59411487", // Total trade volume (in quote asset)
        "openTime": 1660014164909,     // Start of the ticker interval
        "closeTime": 1660100564909,    // End of the ticker interval
        "firstId": 194696115,          // First trade ID
        "lastId": 194968287,           // Last trade ID
        "count": 272173                // Number of trades
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2 // Number of trades
        }
    ]
}
```

If more than one symbol is requested, response returns an array:

```javascript
{
    "id": "901be0d9-fd3b-45e4-acd6-10c580d03430",
    "status": 200,
    "result": [
        {
            "symbol": "BNBBTC",            // Symbol Name
            "priceChange": "0.00016500",
            "priceChangePercent": "1.213",
            "weightedAvgPrice": "0.01382508",
            "prevClosePrice": "0.01360800",
            "lastPrice": "0.01377200",     // Closing price of the interval
            "lastQty": "1.01400000",
            "bidPrice": "0.01377100",
            "bidQty": "7.55700000",
            "askPrice": "0.01377200",
            "askQty": "4.37900000",
            "openPrice": "0.01360700",     // Opening price of the Interval
            "highPrice": "0.01414900",     // Highest price in the interval
            "lowPrice": "0.01346600",      // Lowest  price in the interval
            "volume": "69376.27900000",    // Total trade volume (in base asset)
            "quoteVolume": "959.13277091", // Total trade volume (in quote asset)
            "openTime": 1660014615517,     // Start of the ticker interval
            "closeTime": 1660101015517,    // End of the ticker interval
            "firstId": 194697254,          // First tradeId
            "lastId": 194969483,           // Last tradeId
            "count": 272230                // Trade count
        },
        {
            "symbol": "BTCUSDT",
            "priceChange": "-938.06000000",
            "priceChangePercent": "-3.938",
            "weightedAvgPrice": "23265.34432003",
            "prevClosePrice": "23819.17000000",
            "lastPrice": "22880.91000000",
            "lastQty": "0.00536000",
            "bidPrice": "22880.40000000",
            "bidQty": "0.00424000",
            "askPrice": "22880.91000000",
            "askQty": "0.04276000",
            "openPrice": "23818.97000000",
            "highPrice": "23933.25000000",
            "lowPrice": "22664.69000000",
            "volume": "153508.37606000",
            "quoteVolume": "3571425225.04441220",
            "openTime": 1660014615977,
            "closeTime": 1660101015977,
            "firstId": 1592019902,
            "lastId": 1597301762,
            "count": 5281861
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

<a id="ticker.tradingDay"></a>
<a id="ticker-tradingDay"></a>
<a id="ticker-trading-day"></a>
<a id="ticker-tradingday"></a>

### Trading Day Ticker

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "ticker.tradingDay",
    "params": {
        "symbols": [
            "BNBBTC",
            "BTCUSDT"
        ],
        "timeZone": "00:00"
    }
}
```
Price change statistics for a trading day.

**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.

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | NO |
`symbols` | ARRAY OF STRING | NO |
`timeZone` | STRING | NO | Default: 0 (UTC)
`type` | ENUM | NO | Ticker type. Supported values: FULL (default) or MINI
`symbolStatus` | ENUM | NO | Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK`

**Data Source:** Database

**Notes:**

* Supported values for `timeZone`:
  * Hours and minutes (e.g. `-1:00`, `05:45`)
  * Only hours (e.g. `0`, `8`, `4`)

**Response:**

`FULL` type, with `symbol`:

```javascript
{
    "id": "f4b3b507-c8f2-442a-81a6-b2f12daa030f",
    "status": 200,
    "result": {
        "symbol": "BTCUSDT",
        "priceChange": "-83.13000000",        // Absolute price change
        "priceChangePercent": "-0.317",       // Relative price change in percent
        "weightedAvgPrice": "26234.58803036", // quoteVolume / volume
        "openPrice": "26304.80000000",
        "highPrice": "26397.46000000",
        "lowPrice": "26088.34000000",
        "lastPrice": "26221.67000000",
        "volume": "18495.35066000",           // Volume in base asset
        "quoteVolume": "485217905.04210480",
        "openTime": 1695686400000,
        "closeTime": 1695772799999,
        "firstId": 3220151555,
        "lastId": 3220849281,
        "count": 697727
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

`FULL` type, with `symbols`:

```javascript
{
    "id": "f4b3b507-c8f2-442a-81a6-b2f12daa030f",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "priceChange": "-83.13000000",        // Absolute price change
            "priceChangePercent": "-0.317",       // Relative price change in percent
            "weightedAvgPrice": "26234.58803036", // quoteVolume / volume
            "openPrice": "26304.80000000",
            "highPrice": "26397.46000000",
            "lowPrice": "26088.34000000",
            "lastPrice": "26221.67000000",
            "volume": "18495.35066000",           // Volume in base asset
            "quoteVolume": "485217905.04210480",  // Volume in quote asset
            "openTime": 1695686400000,
            "closeTime": 1695772799999,
            "firstId": 3220151555,                // Trade ID of the first trade in the interval
            "lastId": 3220849281,                 // Trade ID of the last trade in the interval
            "count": 697727                       // Number of trades in the interval
        },
        {
            "symbol": "BNBUSDT",
            "priceChange": "2.60000000",
            "priceChangePercent": "1.238",
            "weightedAvgPrice": "211.92276958",
            "openPrice": "210.00000000",
            "highPrice": "213.70000000",
            "lowPrice": "209.70000000",
            "lastPrice": "212.60000000",
            "volume": "280709.58900000",
            "quoteVolume": "59488753.54750000",
            "openTime": 1695686400000,
            "closeTime": 1695772799999,
            "firstId": 672397461,
            "lastId": 672496158,
            "count": 98698
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 8
        }
    ]
}
```

`MINI` type, with `symbol`:

```javascript
{
    "id": "f4b3b507-c8f2-442a-81a6-b2f12daa030f",
    "status": 200,
    "result": {
        "symbol": "BTCUSDT",
        "openPrice": "26304.80000000",
        "highPrice": "26397.46000000",
        "lowPrice": "26088.34000000",
        "lastPrice": "26221.67000000",
        "volume": "18495.35066000",          // Volume in base asset
        "quoteVolume": "485217905.04210480", // Volume in quote asset
        "openTime": 1695686400000,
        "closeTime": 1695772799999,
        "firstId": 3220151555,               // Trade ID of the first trade in the interval
        "lastId": 3220849281,                // Trade ID of the last trade in the interval
        "count": 697727                      // Number of trades in the interval
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

`MINI` type, with `symbols`:

```javascript
{
    "id": "f4b3b507-c8f2-442a-81a6-b2f12daa030f",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "openPrice": "26304.80000000",
            "highPrice": "26397.46000000",
            "lowPrice": "26088.34000000",
            "lastPrice": "26221.67000000",
            "volume": "18495.35066000",          // Volume in base asset
            "quoteVolume": "485217905.04210480", // Volume in quote asset
            "openTime": 1695686400000,
            "closeTime": 1695772799999,
            "firstId": 3220151555,               // Trade ID of the first trade in the interval
            "lastId": 3220849281,                // Trade ID of the last trade in the interval
            "count": 697727                      // Number of trades in the interval
        },
        {
            "symbol": "BNBUSDT",
            "openPrice": "210.00000000",
            "highPrice": "213.70000000",
            "lowPrice": "209.70000000",
            "lastPrice": "212.60000000",
            "volume": "280709.58900000",
            "quoteVolume": "59488753.54750000",
            "openTime": 1695686400000,
            "closeTime": 1695772799999,
            "firstId": 672397461,
            "lastId": 672496158,
            "count": 98698
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 8
        }
    ]
}
```

<a id="ticker"></a>

### Rolling window price change statistics

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "ticker",
    "params": {
        "symbols": [
            "BNBBTC",
            "BTCUSDT"
        ],
        "windowSize": "7d"
    }
}
```
Get rolling window price change statistics with a custom window.

This request is similar to [`ticker.24hr`](web-socket-api.md#24hr-ticker-price-change-statistics) but statistics are computed on demand using the arbitrary window you specify.

**Note:** Window size precision is limited to 1 minute.
While the `closeTime` is the current time of the request, `openTime` always start on a minute boundary.
As such, the effective window might be up to 59999 ms wider than the requested `windowSize`.

<details>
<summary>Window computation example</summary>

For example, a request for `"windowSize": "7d"` might result in the following window:

```javascript
{
    "openTime": 1659580020000,
    "closeTime": 1660184865291
}
```

Time of the request – `closeTime` – is 1660184865291 (August 11, 2022 02:27:45.291).
Requested window size should put the `openTime` 7 days before that – August 4, 02:27:45.291 –
but due to limited precision it ends up a bit earlier: 1659580020000 (August 4, 2022 02:27:00),
exactly at the start of a minute.
</details>

If you need to continuously monitor trading statistics, please consider using WebSocket Streams:
  * `<symbol>@ticker_<window_size>` or `!ticker_<window-size>@arr`

**Weight:**
Adjusted based on the number of requested symbols:

| Symbols | Weight |
|:-------:|:------:|
|    1–50 | 4 per symbol |
|  51–100 |    200 |

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | NO | Query ticker of a single symbol
`symbols` | ARRAY OF STRING | NO | Query ticker for multiple symbols
`type` | ENUM | NO | Ticker type. Supported values: FULL (default) or MINI
`windowSize` | ENUM | NO | Defaults to 1d if no parameter provided.
`symbolStatus` | ENUM | NO | Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK`

**Data Source:** Database

Supported window sizes:

Unit    | `windowSize` value
------- | ------------------
minutes | `1m`, `2m` ... `59m`
hours   | `1h`, `2h` ... `23h`
days    | `1d`, `2d` ... `7d`

Notes:

* Either `symbol` or `symbols` must be specified.

* Maximum number of symbols in one request: 200.

* Window size units cannot be combined.
  E.g., <code>1d 2h</code> is not supported.

**Response:**

`FULL` type, for a single symbol:

```javascript
{
    "id": "bdb7c503-542c-495c-b797-4d2ee2e91173",
    "status": 200,
    "result": {
        "symbol": "BNBBTC",
        "priceChange": "0.00061500",      // Absolute price change
        "priceChangePercent": "4.735",    // Relative price change in percent
        "weightedAvgPrice": "0.01368242", // QuoteVolume / Volume
        "openPrice": "0.01298900",
        "highPrice": "0.01418800",
        "lowPrice": "0.01296000",
        "lastPrice": "0.01360400",
        "volume": "587179.23900000",
        "quoteVolume": "8034.03382165",   // Sum of (price * volume) for all trades
        "openTime": 1659580020000,        // Open time for ticker window
        "closeTime": 1660184865291,       // Close time for ticker window
        "firstId": 192977765,             // Trade IDs
        "lastId": 195365758,
        "count": 2387994                  // Number of trades in the interval
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

`MINI` type, for a single symbol:

```javascript
{
    "id": "bdb7c503-542c-495c-b797-4d2ee2e91173",
    "status": 200,
    "result": {
        "symbol": "BNBBTC",
        "openPrice": "0.01298900",
        "highPrice": "0.01418800",
        "lowPrice": "0.01296000",
        "lastPrice": "0.01360400",
        "volume": "587179.23900000",
        "quoteVolume": "8034.03382165", // Sum of (price * volume) for all trades
        "openTime": 1659580020000,      // Open time for ticker window
        "closeTime": 1660184865291,     // Close time for ticker window
        "firstId": 192977765,           // First trade ID
        "lastId": 195365758,            // Last trade ID
        "count": 2387994                // Number of trades
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4 // Number of trades
        }
    ]
}
```

If more than one symbol is requested, response returns an array:

```javascript
{
    "id": "f4b3b507-c8f2-442a-81a6-b2f12daa030f",
    "status": 200,
    "result": [
        {
            "symbol": "BNBBTC",
            "priceChange": "0.00061500",      // Absolute price change
            "priceChangePercent": "4.735",    // Relative price change in percent
            "weightedAvgPrice": "0.01368242", // QuoteVolume / Volume
            "openPrice": "0.01298900",
            "highPrice": "0.01418800",
            "lowPrice": "0.01296000",
            "lastPrice": "0.01360400",
            "volume": "587169.48600000",
            "quoteVolume": "8033.90114517",   // Sum of (price * volume) for all trades
            "openTime": 1659580020000,        // Open time for ticker window
            "closeTime": 1660184820927,       // Close time for ticker window
            "firstId": 192977765,             // Trade IDs
            "lastId": 195365700,
            "count": 2387936                  // Number of trades in the interval
        },
        {
            "symbol": "BTCUSDT",
            "priceChange": "1182.92000000",
            "priceChangePercent": "5.113",
            "weightedAvgPrice": "23349.27074846",
            "openPrice": "23135.33000000",
            "highPrice": "24491.22000000",
            "lowPrice": "22400.00000000",
            "lastPrice": "24318.25000000",
            "volume": "1039498.10978000",
            "quoteVolume": "24271522807.76838630",
            "openTime": 1659580020000,
            "closeTime": 1660184820927,
            "firstId": 1568787779,
            "lastId": 1604337406,
            "count": 35549628
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 8
        }
    ]
}
```

<a id="ticker.price"></a>
<a id="ticker-price"></a>

### Symbol price ticker

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "ticker.price"
}
```
Get the latest market price for a symbol.

If you need access to real-time price updates, please consider using
WebSocket Streams:

* `<symbol>@aggTrade`

* `<symbol>@trade`

**Weight:**
Adjusted based on the number of requested symbols:

|Parameter|Symbols Provided|Weight|
|---|---|---|
|symbol| 1 |2|
| |omitted| 4|
|symbols| Any |4|

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | NO | Query price for a single symbol
`symbols` | ARRAY OF STRING | NO | Query price for multiple symbols
`symbolStatus` | ENUM | NO | Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK`

**Data Source:** Memory

Notes:

* `symbol` and `symbols` cannot be used together.

* If no symbol is specified, returns information about all symbols currently trading on the exchange.

**Response - when a single symbol is requested:**
```javascript
{
    "id": "043a7cf2-bde3-4888-9604-c8ac41fcba4d",
    "status": 200,
    "result": {
        "symbol": "BNBBTC",
        "price": "0.01361900"
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

**Response - when multiple symbols are requested:**
```javascript
{
    "id": "e739e673-24c8-4adf-9cfa-b81f30330b09",
    "status": 200,
    "result": [
        {
            "symbol": "BNBBTC",
            "price": "0.01363700"
        },
        {
            "symbol": "BTCUSDT",
            "price": "24267.15000000"
        },
        {
            "symbol": "BNBBUSD",
            "price": "331.10000000"
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

<a id="ticker.book"></a>
<a id="ticker-book"></a>

### Symbol order book ticker

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "ticker.book"
}
```
Get the current best price and quantity on the order book.

If you need access to real-time order book ticker updates, please
consider using WebSocket Streams:

* [`<symbol>@bookTicker`](web-socket-streams.md#individual-symbol-book-ticker-streams)

**Weight:**
Adjusted based on the number of requested symbols:

|Parameter|Symbols Provided|Weight|
|---|---|---|
|symbol| 1 |2|
| |omitted| 4|
|symbols| Any |4|

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | NO | Query ticker for a single symbol
`symbols` | ARRAY OF STRING | NO | Query ticker for multiple symbols
`symbolStatus` | ENUM | NO | Filters for symbols that have this `tradingStatus`. For a single symbol, a status mismatch returns error `-1220 SYMBOL_DOES_NOT_MATCH_STATUS`. For multiple or all symbols, non-matching ones are simply excluded from the response. Valid values: `TRADING`, `HALT`, `BREAK`

**Data Source:** Memory

Notes:

* `symbol` and `symbols` cannot be used together.

* If no symbol is specified, returns information about all symbols currently trading on the exchange.

**Response - when a single symbol is requested:**
```javascript
{
    "id": "9d32157c-a556-4d27-9866-66760a174b57",
    "status": 200,
    "result": {
        "symbol": "BNBBTC",
        "bidPrice": "0.01358000", // best bid price.
        "bidQty": "12.53400000",  // bid/ask qty.
        "askPrice": "0.01358100", // best ask price.
        "askQty": "17.83700000"   // bid/ask qty.
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

**Response - when multiple symbols are requested:**
```javascript
{
    "id": "057deb3a-2990-41d1-b58b-98ea0f09e1b4",
    "status": 200,
    "result": [
        {
            "symbol": "BNBBTC",
            "bidPrice": "0.01358000", // best bid price.
            "bidQty": "12.53400000",  // bid/ask qty.
            "askPrice": "0.01358100", // best ask price.
            "askQty": "17.83700000"   // bid/ask qty.
        },
        {
            "symbol": "BTCUSDT",
            "bidPrice": "23980.49000000",
            "bidQty": "0.01000000",
            "askPrice": "23981.31000000",
            "askQty": "0.01512000"
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

<a id="referencePrice"></a>
<a id="reference-price"></a>
<a id="referenceprice"></a>

### Query Reference Price

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "referencePrice",
    "params": {
        "symbol": "BAZUSD"
    }
}
```

**Weight:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |

**Data Source:** Memory

If the symbol has never had a reference price set, the request is rejected with:

```json
{
    "code": -2043,
    "msg": "This symbol doesn't have a reference price."
}
```

**Response:**

If a reference price is set:

```javascript
{
    "id": "ddbfb65f-9ebf-42ec-8240-8f0f91de0867",
    "status": 200,
    "result": {
        "symbol": "BAZUSD",
        "referencePrice": "0.00501900",
        "timestamp": 1770946889251 // Timestamp when the reference price was valid
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

If no reference price is set:

```javascript
{
    "id": "5132affb-0aba-4821-b475-f262504556b43",
    "status": 200,
    "result": {
        "symbol": "BAZUSD",
        "referencePrice": null,
        "timestamp": 1770946889251 // Timestamp when the reference price was valid
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

If no reference price has ever been set:

```javascript
{
    "id": "5132affa-0aba-4831-b475-f262504556b41",
    "status": 200,
    "result": {
        "code": -2043,
        "msg": "This symbol doesn't have a reference price."
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

<a id="referencePrice.calculation"></a>
<a id="referencePrice-calculation"></a>
<a id="reference-price-calculation"></a>
<a id="referenceprice-calculation"></a>

### Query Reference Price Calculation

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "referencePrice.calculation",
    "params": {
        "symbol": "BAZUSD"
    }
}
```

**Weight:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`symbol` | STRING | YES |
`symbolStatus` | ENUM | NO |

**Data Source:** Memory

**Response:**

If the reference price is being calculated by the matching engine as an arithmetic mean:

```javascript
{
    "id": "ddbfb65f-9ebf-42ec-8240-8f0f91de0867",
    "status": 200,
    "result": {
        "symbol": "BAZUSD",
        "calculationType": "ARITHMETIC_MEAN",
        "bucketCount": 10,          // If the reference price is being calculated by the matching engine as an arithmetic mean
        "bucketWidthMs": 1000,      // If the reference price is being calculated by the matching engine as an arithmetic mean
        "externalCalculationId": 42 // If the reference price is being calculated outside the matching engine
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

If the reference price is being calculated outside the matching engine:

```javascript
{
    "id": "5132affa-0aba-4831-b475-f262504556b41",
    "status": 200,
    "result": {
        "symbol": "BAZUSD",
        "calculationType": "EXTERNAL",
        "externalCalculationId": 42 // If the reference price is being calculated outside the matching engine
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

If reference price is not being calculated:

```javascript
{
    "id": "5132affa-0aba-4831-b475-f262504556b41",
    "status": 400,
    "error": {
        "code": -2043,
        "msg": "This symbol doesn't have a reference price."
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 2
        }
    ]
}
```

## Authentication requests

<a id="session.status"></a>
<a id="session-status"></a>

### Query session status

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "session.status"
}
```
Query the status of the WebSocket connection,
inspecting which API key (if any) is used to authorize requests.

**Weight:**
2

**Parameters:**
NONE

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "b50c16cd-62c9-4e29-89e4-37f10111f5bf",
    "status": 200,
    "result": {
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A", // `null` if the connection is not authenticated.
        "authorizedSince": 1649729878532,                                             // `null` if the connection is not authenticated.
        "connectedSince": 1649729873021,
        "returnRateLimits": false,
        "serverTime": 1649730611671,
        "userDataStream": true                                                        // Is User Data Stream subscription active?
    }
}
```

<a id="session.logout"></a>
<a id="session-logout"></a>

### Log out of the session

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "session.logout"
}
```
Forget the API key previously authenticated. If the connection is not authenticated, this request does nothing.

Note that the WebSocket connection stays open after `session.logout` request. You can continue using the connection, but now you will have to explicitly provide the `apiKey` and `signature` parameters where needed.

**Weight:**
2

**Parameters:**
NONE

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "c174a2b1-3f51-4580-b200-8528bd237cb7",
    "status": 200,
    "result": {
        "apiKey": null,
        "authorizedSince": null,
        "connectedSince": 1649729873021,
        "returnRateLimits": false,
        "serverTime": 1649730611671,
        "userDataStream": false // Is User Data Stream subscription active?
    }
}
```

<a id="session.logon"></a>
<a id="session-logon"></a>
<a id="log-in-with-api-key-signed"></a>

### Log in with API key (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "session.logon",
    "params": {
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Authenticate WebSocket connection using the provided API key.

After calling `session.logon`, you can omit `apiKey` and `signature` parameters for future requests that require them.

Note that only one API key can be authenticated.

Calling `session.logon` multiple times changes the current authenticated API key.

**Note:** Only Ed25519 keys are supported for this feature.

**Weight:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> The value cannot be greater than `60000`. Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "c174a2b1-3f51-4580-b200-8528bd237cb7",
    "status": 200,
    "result": {
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "authorizedSince": 1649729878532,
        "connectedSince": 1649729873021,
        "returnRateLimits": false,
        "serverTime": 1649729878630,
        "userDataStream": false // Is User Data Stream subscription active?
    }
}
```

## Trading requests

<a id="order.place"></a>
<a id="order-place"></a>

### Place new order (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "order.place",
    "params": {
        "symbol": "BTCUSDT",
        "side": "SELL",
        "type": "LIMIT",
        "timeInForce": "GTC",
        "price": "23416.10000000",
        "quantity": "0.00847000",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Send in a new order.

This adds 1 order to the `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter.

**Weight:**
1

**Unfilled Order Count:**
1

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`side` | ENUM | YES | Please see [Enums](enums.md#side) for supported values.
`type` | ENUM | YES | Please see [Enums](enums.md#ordertypes) for supported values.
`timeInForce` | ENUM | NO | Please see [Enums](enums.md#timeinforce) for supported values.
`price` | DECIMAL | NO |
`quantity` | DECIMAL | NO |
`quoteOrderQty` | DECIMAL | NO |
`newClientOrderId` | STRING | NO | A unique id among open orders. Automatically generated if not sent.<br/> Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected.
`newOrderRespType` | ENUM | NO | `MARKET` and `LIMIT` order types default to `FULL`, all other orders default to `ACK`.
`stopPrice` | DECIMAL | NO | Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders.
`trailingDelta` | INT | NO | See Trailing Stop order FAQ
`icebergQty` | DECIMAL | NO | Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order.
`strategyId` | LONG | NO |
`strategyType` | INT | NO | The value cannot be less than `1000000`.
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol.
`pegPriceType` | ENUM | NO | See Pegged Orders Info
`pegOffsetValue` | INT | NO | Maximum: 100. <br/> Price level to peg the price to (max: 100). See Pegged Orders Info
`pegOffsetType` | ENUM | NO | Only `PRICE_LEVEL` is supported. See Pegged Orders Info
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

<a id="order-type">Certain parameters (*)</a> become mandatory based on the order `type`:

<table>
<thead>
    <tr>
        <th>Order <code>type</code></th>
        <th>Mandatory parameters</th>
    </tr>
</thead>
<tbody>
    <tr>
        <td><code>LIMIT</code></td>
        <td>
        <ul>
            <li><code>timeInForce</code></li>
            <li><code>price</code></li>
            <li><code>quantity</code></li>
        </ul>
        </td>
    </tr>
    <tr>
        <td><code>LIMIT_MAKER</code></td>
        <td>
        <ul>
            <li><code>price</code></li>
            <li><code>quantity</code></li>
        </ul>
        </td>
    </tr>
    <tr>
        <td><code>MARKET</code></td>
        <td>
        <ul>
            <li><code>quantity</code> or <code>quoteOrderQty</code></li>
        </ul>
        </td>
    </tr>
    <tr>
        <td><code>STOP_LOSS</code></td>
        <td>
        <ul>
            <li><code>quantity</code></li>
            <li><code>stopPrice</code> or <code>trailingDelta</code></li>
        </ul>
        </td>
    </tr>
    <tr>
        <td><code>STOP_LOSS_LIMIT</code></td>
        <td>
        <ul>
            <li><code>timeInForce</code></li>
            <li><code>price</code></li>
            <li><code>quantity</code></li>
            <li><code>stopPrice</code> or <code>trailingDelta</code></li>
        </ul>
        </td>
    </tr>
    <tr>
        <td><code>TAKE_PROFIT</code></td>
        <td>
        <ul>
            <li><code>quantity</code></li>
            <li><code>stopPrice</code> or <code>trailingDelta</code></li>
        </ul>
        </td>
    </tr>
    <tr>
        <td><code>TAKE_PROFIT_LIMIT</code></td>
        <td>
        <ul>
            <li><code>timeInForce</code></li>
            <li><code>price</code></li>
            <li><code>quantity</code></li>
            <li><code>stopPrice</code> or <code>trailingDelta</code></li>
        </ul>
        </td>
    </tr>
</tbody>
</table>

Supported order types:

<table>
<thead>
    <tr>
        <th>Order <code>type</code></th>
        <th>Description</th>
    </tr>
</thead>
<tbody>
    <tr>
        <td><code>LIMIT</code></td>
        <td>
        <p>
            Buy or sell <code>quantity</code> at the specified <code>price</code> or better.
        </p>
        </td>
    </tr>
    <tr>
        <td><code>LIMIT_MAKER</code></td>
        <td>
        <p>
            <code>LIMIT</code> order that will be rejected if it immediately matches and trades as a taker.
        </p>
        <p>
            This order type is also known as a POST-ONLY order.
        </p>
        </td>
    </tr>
    <tr>
        <td><code>MARKET</code></td>
        <td>
        <p>
            Buy or sell at the best available market price.
        </p>
        <ul>
            <li>
                <p>
                    <code>MARKET</code> order with <code>quantity</code> parameter
                    specifies the amount of the <em>base asset</em> you want to buy or sell.
                    Actually executed quantity of the quote asset will be determined by available market liquidity.
                </p>
                <p>
                    E.g., a MARKET BUY order on BTCUSDT for <code>"quantity": "0.1000"</code>
                    specifies that you want to buy 0.1 BTC at the best available price.
                    If there is not enough BTC at the best price, keep buying at the next best price,
                    until either your order is filled, or you run out of USDT, or market runs out of BTC.
                </p>
            </li>
            <li>
                <p>
                    <code>MARKET</code> order with <code>quoteOrderQty</code> parameter
                    specifies the amount of the <em>quote asset</em> you want to spend (when buying) or receive (when selling).
                    Actually executed quantity of the base asset will be determined by available market liquidity.
                </p>
                <p>
                    E.g., a MARKET BUY on BTCUSDT for <code>"quoteOrderQty": "100.00"</code>
                    specifies that you want to buy as much BTC as you can for 100 USDT at the best available price.
                    Similarly, a SELL order will sell as much available BTC as needed for you to receive 100 USDT
                    (before commission).
                </p>
            </li>
        </ul>
        </td>
    </tr>
    <tr>
        <td><code>STOP_LOSS</code></td>
        <td>
        <p>
            Execute a <code>MARKET</code> order for given <code>quantity</code> when specified conditions are met.
        </p>
        <p>
            I.e., when <code>stopPrice</code> is reached, or when <code>trailingDelta</code> is activated.
        </p>
        </td>
    </tr>
    <tr>
        <td><code>STOP_LOSS_LIMIT</code></td>
        <td>
        <p>
            Place a <code>LIMIT</code> order with given parameters when specified conditions are met.
        </p>
        </td>
    </tr>
    <tr>
        <td><code>TAKE_PROFIT</code></td>
        <td>
        <p>
            Like <code>STOP_LOSS</code> but activates when market price moves in the favorable direction.
        </p>
        </td>
    </tr>
    <tr>
        <td><code>TAKE_PROFIT_LIMIT</code></td>
        <td>
        <p>
            Like <code>STOP_LOSS_LIMIT</code> but activates when market price moves in the favorable direction.
        </p>
        </td>
    </tr>
</tbody>
</table>

<a id="pegged-orders-info"></a>
Notes on using parameters for Pegged Orders:

* These parameters are allowed for `LIMIT`, `LIMIT_MAKER`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_LIMIT` orders.
* If `pegPriceType` is specified, `price` becomes optional. Otherwise, it is still mandatory.
* `pegPriceType=PRIMARY_PEG` means the primary peg, that is the best price on the same side of the order book as your order.
* `pegPriceType=MARKET_PEG` means the market peg, that is the best price on the opposite side of the order book from your order.
* Use `pegOffsetType` and `pegOffsetValue` to request a price level other than the best one. These parameters must be specified together.

<a id="timeInForce"></a>

Available `timeInForce` options,
setting how long the order should be active before expiration:

TIF  | Description
----- | --------------
`GTC` | **Good 'til Canceled** – the order will remain on the book until you cancel it, or the order is completely filled.
`IOC` | **Immediate or Cancel** – the order will be filled for as much as possible, the unfilled quantity immediately expires.
`FOK` | **Fill or Kill** – the order will expire unless it cannot be immediately filled for the entire quantity.

Notes:

* `newClientOrderId` specifies `clientOrderId` value for the order.

  A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired.

* Any `LIMIT` or `LIMIT_MAKER` order can be made into an iceberg order by specifying the `icebergQty`.

  An order with an `icebergQty` must have `timeInForce` set to `GTC`.

* Trigger order price rules for `STOP_LOSS`/`TAKE_PROFIT` orders:

  * `stopPrice` must be above market price: `STOP_LOSS BUY`, `TAKE_PROFIT SELL`
  * `stopPrice` must be below market price: `STOP_LOSS SELL`, `TAKE_PROFIT BUY`

* `MARKET` orders using `quoteOrderQty` follow [`LOT_SIZE`](filters.md#lot_size) filter rules.

  The order will execute a quantity that has notional value as close as possible to requested `quoteOrderQty`.

**Response:**

Response format is selected by using the `newOrderRespType` parameter.
`ACK` response type:

```javascript
{
    "id": "56374a46-3061-486b-a311-99ee972eb648",
    "status": 200,
    "result": {
        "symbol": "BTCUSDT",
        "orderId": 12569099453,
        "orderListId": -1, // always -1 for singular orders
        "clientOrderId": "4d96324ff9d44481926157ec08158a40",
        "transactTime": 1660801715639
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

`RESULT` response type:

```javascript
{
    "id": "56374a46-3061-486b-a311-99ee972eb648",
    "status": 200,
    "result": {
        "symbol": "BTCUSDT",
        "orderId": 12569099453,
        "orderListId": -1, // always -1 for singular orders
        "clientOrderId": "4d96324ff9d44481926157ec08158a40",
        "transactTime": 1660801715639,
        "price": "23416.10000000",
        "origQty": "0.00847000",
        "executedQty": "0.00000000",
        "origQuoteOrderQty": "0.000000",
        "cummulativeQuoteQty": "0.00000000",
        "status": "NEW",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "SELL",
        "workingTime": 1660801715639,
        "selfTradePreventionMode": "NONE"
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

`FULL` response type:

```javascript
{
    "id": "56374a46-3061-486b-a311-99ee972eb648",
    "status": 200,
    "result": {
        "symbol": "BTCUSDT",
        "orderId": 12569099453,
        "orderListId": -1,
        "clientOrderId": "4d96324ff9d44481926157ec08158a40",
        "transactTime": 1660801715793,
        "price": "23416.10000000",
        "origQty": "0.00847000",
        "executedQty": "0.00847000",
        "origQuoteOrderQty": "0.000000",
        "cummulativeQuoteQty": "198.33521500",
        "status": "FILLED",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "SELL",
        "workingTime": 1660801715639,
        "selfTradePreventionMode": "NONE",
        "stopPrice": "0.00000000",                // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
        "trailingDelta": 10,                      // Delta price change required before order activation.
        "icebergQty": "0.00000000",               // Appears only if the parameter icebergQty was sent in the request.
        "strategyId": 1,                          // Appears only if the strategyId parameter was provided upon order placement.
        "strategyType": 1000000,                  // Appears only if the strategyType parameter was provided upon order placement.
        "preventedMatchId": 0,                    // Appears only if the order expired due to STP.
        "preventedQuantity": "1.200000",          // Order quantity that expired due to STP.
        "trailingTime": -1,                       // Time when the trailing order is now active and tracking price changes.
        "usedSor": true,                          // Field that determines whether order used SOR.
        "workingFloor": "SOR",                    // Determines whether the order is being filled by the SOR or by the order book.
        "pegPriceType": "PRIMARY_PEG",            // Price peg type. Only for pegged orders.
        "pegOffsetType": "PRICE_LEVEL",           // Price peg offset type. Only for pegged orders, if requested.
        "pegOffsetValue": 5,                      // Price peg offset value. Only for pegged orders, if requested.
        "peggedPrice": "87523.83710000",          // Current price order is pegged at. Only for pegged orders, once determined.
        "expiryReason": "INSUFFICIENT_LIQUIDITY", // Cause of the order's expiration. Appears when an order has expired.
        // FULL response is identical to RESULT response, with the same optional fields
        // based on the order type and parameters. FULL response additionally includes
        // the list of trades which immediately filled the order.
        "fills": [
            {
                "price": "23416.10000000",
                "qty": "0.00635000",
                "commission": "0.000000",
                "commissionAsset": "BNB",
                "tradeId": 1650422481
            },
            {
                "price": "23416.50000000",
                "qty": "0.00212000",
                "commission": "0.000000",
                "commissionAsset": "BNB",
                "tradeId": 1650422482
            }
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

<a id="order.test"></a>
<a id="order-test"></a>

### Test new order (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "order.test",
    "params": {
        "symbol": "BTCUSDT",
        "side": "SELL",
        "type": "LIMIT",
        "timeInForce": "GTC",
        "price": "23416.10000000",
        "quantity": "0.00847000",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Test order placement.

Validates new order parameters and verifies your signature
but does not send the order into the matching engine.

**Weight:**
| Condition | Request Weight |
| --- | --- |
| Without `computeCommissionRates` | 1 |
| With `computeCommissionRates` | 20 |

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`computeCommissionRates` | BOOLEAN | NO | Default: `false` <br> See [Commissions FAQ](faqs/commission_faq.md#test-order-diferences) to learn more.
`symbol` | STRING | YES |
`side` | ENUM | YES | Please see [Enums](enums.md#side) for supported values.
`type` | ENUM | YES | Please see [Enums](enums.md#ordertypes) for supported values.
`timeInForce` | ENUM | NO | Please see [Enums](enums.md#timeinforce) for supported values.
`price` | DECIMAL | NO |
`quantity` | DECIMAL | NO |
`quoteOrderQty` | DECIMAL | NO |
`newClientOrderId` | STRING | NO | A unique id among open orders. Automatically generated if not sent. Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected.
`newOrderRespType` | ENUM | NO | Set the response JSON. `ACK`, `RESULT`, or `FULL`; `MARKET` and `LIMIT` order types default to `FULL`, all other orders default to `ACK`.
`stopPrice` | DECIMAL | NO | Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders.
`trailingDelta` | INT | NO | See [Trailing Stop order FAQ](faqs/trailing-stop-faq.md)
`icebergQty` | DECIMAL | NO | Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order.
`strategyId` | LONG | NO |
`strategyType` | INT | NO | The value cannot be less than `1000000`.
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](enums.md#stpmodes)
`pegPriceType` | ENUM | NO | `PRIMARY_PEG` or `MARKET_PEG`. See [Pegged Orders](faqs/pegged_orders.md)
`pegOffsetValue` | INT | NO | Maximum: 100. <br/> Price level for pegging (max: 100). See [Pegged Orders](faqs/pegged_orders.md)
`pegOffsetType` | ENUM | NO | Only `PRICE_LEVEL` is supported. See [Pegged Orders](faqs/pegged_orders.md)
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory

**Response:**

Without `computeCommissionRates`:

```javascript
{
    "id": "6ffebe91-01d9-43ac-be99-57cf062e0e30",
    "status": 200,
    "result": {},
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

With `computeCommissionRates`:

```javascript
{
    "id": "6ffebe91-01d9-43ac-be99-57cf062e0e30",
    "status": 200,
    "result": {
        // Standard commission rates on trades from the order.
        "standardCommissionForOrder": {
            "maker": "0.00000112",
            "taker": "0.00000114"
        },
        // Special commission rates on trades from the order.
        "specialCommissionForOrder": {
            "maker": "0.05000000",
            "taker": "0.06000000"
        },
        // Tax commission rates for trades from the order.
        "taxCommissionForOrder": {
            "maker": "0.00000112",
            "taker": "0.00000114"
        },
        // Discount on standard commissions when paying in BNB.
        "discount": {
            "enabledForAccount": true,
            "enabledForSymbol": true,
            "discountAsset": "BNB",
            "discount": "0.25000000" // Standard commission is reduced by this rate when paying commission in BNB.
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

<a id="order.cancel"></a>
<a id="order-cancel"></a>

### Cancel order (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "order.cancel",
    "params": {
        "symbol": "BTCUSDT",
        "origClientOrderId": "4d96324ff9d44481926157",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Cancel an active order.

**Weight:**
1

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`orderId` | LONG | NO |
`origClientOrderId` | STRING | NO |
`newClientOrderId` | STRING | NO | Used to uniquely identify this cancel. Automatically generated by default.
`cancelRestrictions` | ENUM | NO | Supported values: <br>`ONLY_NEW` - Cancel will succeed if the order status is `NEW`.<br> `ONLY_PARTIALLY_FILLED` - Cancel will succeed if order status is `PARTIALLY_FILLED`. For more information please refer to [Regarding `cancelRestrictions`](#regarding-cancelrestrictions).
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

Notes:

* If both `orderId` and `origClientOrderId` parameters are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected.

* `newClientOrderId` will replace `clientOrderId` of the canceled order, freeing it up for new orders.

* If you cancel an order that is a part of an order list, the entire order list is canceled.

* The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower.

**Response:**

When an individual order is canceled:

```javascript
{
    "id": "5633b6a2-90a9-4192-83e7-925c90b6a2fd",
    "status": 200,
    "result": {
        "symbol": "BTCUSDT",
        "origClientOrderId": "4d96324ff9d44481926157", // clientOrderId that was canceled
        "orderId": 12569099453,
        "orderListId": -1,                             // set only for legs of an order list
        "clientOrderId": "91fe37ce9e69c90d6358c0",     // newClientOrderId from request
        "transactTime": 1684804350068,
        "price": "23416.10000000",
        "origQty": "0.00847000",
        "executedQty": "0.00001000",
        "origQuoteOrderQty": "0.000000",
        "cummulativeQuoteQty": "0.23416100",
        "status": "CANCELED",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "SELL",
        "stopPrice": "0.00000000",                     // present only if stopPrice set for the order
        "trailingDelta": 0,                            // present only if trailingDelta set for the order
        "icebergQty": "0.00000000",                    // present only if icebergQty set for the order
        "strategyId": 37463720,                        // present only if strategyId set for the order
        "strategyType": 1000000,                       // present only if strategyType set for the order
        "selfTradePreventionMode": "NONE"
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

When an order list is canceled:

```javascript
{
    "id": "16eaf097-bbec-44b9-96ff-e97e6e875870",
    "status": 200,
    "result": {
        "symbol": "BTCUSDT",
        "origClientOrderId": "4d96324ff9d44481926157",
        "orderId": 12569099453,
        "orderListId": 19431,
        "clientOrderId": "91fe37ce9e69c90d6358c0",
        "transactTime": 1684804350068,
        "price": "23416.10000000",
        "origQty": "0.00847000",
        "executedQty": "0.00001000",
        "origQuoteOrderQty": "0.000000",
        "cummulativeQuoteQty": "0.23416100",
        "status": "CANCELED",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "SELL",
        "stopPrice": "0.00000000",                // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
        "trailingDelta": 10,                      // Delta price change required before order activation.
        "icebergQty": "0.00000000",               // Appears only if the parameter icebergQty was sent in the request.
        "strategyId": 1,                          // Appears only if the strategyId parameter was provided upon order placement.
        "strategyType": 1000000,                  // Appears only if the strategyType parameter was provided upon order placement.
        "selfTradePreventionMode": "NONE",
        "preventedMatchId": 0,                    // Appears only if the order expired due to STP.
        "preventedQuantity": "1.200000",          // Order quantity that expired due to STP.
        "trailingTime": -1,                       // Time when the trailing order is now active and tracking price changes.
        "usedSor": true,                          // Field that determines whether order used SOR.
        "workingFloor": "SOR",                    // Determines whether the order is being filled by the SOR or by the order book.
        "pegPriceType": "PRIMARY_PEG",            // Price peg type. Only for pegged orders.
        "pegOffsetType": "PRICE_LEVEL",           // Price peg offset type. Only for pegged orders, if requested.
        "pegOffsetValue": 5,                      // Price peg offset value. Only for pegged orders, if requested.
        "peggedPrice": "87523.83710000",          // Current price order is pegged at. Only for pegged orders, once determined.
        "expiryReason": "INSUFFICIENT_LIQUIDITY", // Cause of the order's expiration. Appears when an order has expired.
        "contingencyType": "OCO",
        "listStatusType": "ALL_DONE",
        "listOrderStatus": "ALL_DONE",
        "listClientOrderId": "iuVNVJYYrByz6C4yGOPPK0",
        "transactionTime": 1660803702431,
        "orders": [
            {
                "symbol": "BTCUSDT",
                "orderId": 12569099453,
                "clientOrderId": "bX5wROblo6YeDwa9iTLeyY"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 12569099454,
                "clientOrderId": "Tnu2IP0J5Y4mxw3IATBfmW"
            }
        ],
        // order list order's status format is the same as for individual orders.
        "orderReports": [
            {
                "symbol": "BTCUSDT",
                "origClientOrderId": "bX5wROblo6YeDwa9iTLeyY",
                "orderId": 12569099453,
                "orderListId": 19431,
                "clientOrderId": "OFFXQtxVFZ6Nbcg4PgE2DA",
                "transactTime": 1684804350068,
                "price": "23450.50000000",
                "origQty": "0.00850000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "CANCELED",
                "timeInForce": "GTC",
                "type": "STOP_LOSS_LIMIT",
                "side": "BUY",
                "stopPrice": "23430.00000000", // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "BTCUSDT",
                "origClientOrderId": "Tnu2IP0J5Y4mxw3IATBfmW",
                "orderId": 12569099454,
                "orderListId": 19431,
                "clientOrderId": "OFFXQtxVFZ6Nbcg4PgE2DA",
                "transactTime": 1684804350068,
                "price": "23400.00000000",
                "origQty": "0.00850000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "CANCELED",
                "timeInForce": "GTC",
                "type": "LIMIT_MAKER",
                "side": "BUY",
                "selfTradePreventionMode": "NONE"
            }
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="regarding-cancelrestrictions"></a>

**Regarding `cancelRestrictions`**

* If the `cancelRestrictions` value is not any of the supported values, the error will be:
```json
{
    "code": -1145,
    "msg": "Invalid cancelRestrictions"
}
```
* If the order did not pass the conditions for `cancelRestrictions`, the error will be:
```json
{
    "code": -2011,
    "msg": "Order was not canceled due to cancel restrictions."
}
```

<a id="order.cancelReplace"></a>
<a id="order-cancelReplace"></a>
<a id="order-cancel-replace"></a>
<a id="order-cancelreplace"></a>

### Cancel and replace order (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "order.cancelReplace",
    "params": {
        "symbol": "BTCUSDT",
        "cancelReplaceMode": "ALLOW_FAILURE",
        "cancelOrigClientOrderId": "4d96324ff9d44481926157",
        "side": "SELL",
        "type": "LIMIT",
        "timeInForce": "GTC",
        "price": "23416.10000000",
        "quantity": "0.00847000",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
* Cancel an existing order and immediately place a new order instead of the canceled one.
* A new order that was not attempted (i.e. when `newOrderResult: NOT_ATTEMPTED`), will still increase the unfilled order count by 1.
* You can only cancel an individual order from an orderList using this method, but the result is the same as canceling the entire orderList.

**Weight:**
1

**Unfilled Order Count:**
1

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`cancelReplaceMode` | ENUM | YES | The allowed values are: <br/> `STOP_ON_FAILURE` - If the cancel request fails, the new order placement will not be attempted. <br/> `ALLOW_FAILURE` - new order placement will be attempted even if cancel request fails.
`cancelOrderId` | LONG | NO | Either `cancelOrderId` or `cancelOrigClientOrderId` must be sent. <br></br>If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order. <br></br>If both conditions are not met the request will be rejected.
`cancelOrigClientOrderId` | STRING | NO | Either `cancelOrderId` or `cancelOrigClientOrderId` must be sent. <br></br> If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order. <br></br> If both conditions are not met the request will be rejected.
`cancelNewClientOrderId` | STRING | NO | Used to uniquely identify this cancel. Automatically generated by default.
`side` | ENUM | YES | Please see [Enums](enums.md#side) for supported values.
`type` | ENUM | YES | Please see [Enums](enums.md#ordertypes) for supported values.
`timeInForce` | ENUM | NO | Please see [Enums](enums.md#timeinforce) for supported values.
`price` | DECIMAL | NO |
`quantity` | DECIMAL | NO |
`quoteOrderQty` | DECIMAL | NO |
`newClientOrderId` | STRING | NO | Used to identify the new order.
`newOrderRespType` | ENUM | NO | Allowed values: <br/> `ACK`, `RESULT`, `FULL` <br/> `MARKET` and `LIMIT` orders types default to `FULL`; all other orders default to `ACK`
`stopPrice` | DECIMAL | NO | Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders.
`trailingDelta` | DECIMAL | NO | See [Trailing Stop order FAQ](faqs/trailing-stop-faq.md)
`icebergQty` | DECIMAL | NO | Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order.
`strategyId` | LONG | NO |
`strategyType` | INT | NO | The value cannot be less than `1000000`.
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol. The possible supported values are: [STP Modes](enums.md#stpmodes).
`cancelRestrictions` | ENUM | NO | Supported values: <br>`ONLY_NEW` - Cancel will succeed if the order status is `NEW`.<br> `ONLY_PARTIALLY_FILLED` - Cancel will succeed if order status is `PARTIALLY_FILLED`. For more information please refer to [Regarding `cancelRestrictions`](#regarding-cancelrestrictions).
`orderRateLimitExceededMode` | ENUM | NO | Supported values: <br> `DO_NOTHING` (default)- will only attempt to cancel the order if account has not exceeded the unfilled order rate limit<br> `CANCEL_ONLY` - will always cancel the order
`pegPriceType` | ENUM | NO | `PRIMARY_PEG` or `MARKET_PEG` <br> See Pegged Orders
`pegOffsetValue` | INT | NO | Maximum: 100. <br/> Price level to peg the price to (max: 100) <br> See Pegged Orders
`pegOffsetType` | ENUM | NO | Only `PRICE_LEVEL` is supported <br> See Pegged Orders
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

Similar to the [`order.place`](web-socket-api.md#place-new-order-trade) request,
additional mandatory parameters (*) are determined by the new order `type`.

Available `cancelReplaceMode` options:

* `STOP_ON_FAILURE` – if cancellation request fails, new order placement will not be attempted.
* `ALLOW_FAILURE` – new order placement will be attempted even if the cancel request fails.

<table>
<thead>
    <tr>
        <th colspan=3 align=left>Request</th>
        <th colspan=3 align=left>Response</th>
    </tr>
    <tr>
        <th><code>cancelReplaceMode</code></th>
        <th><code>orderRateLimitExceededMode</code></th>
        <th>Unfilled Order Count</th>
        <th><code>cancelResult</code></th>
        <th><code>newOrderResult</code></th>
        <th><code>status</code></th>
    </tr>
</thead>
<tbody>
    <tr>
        <td rowspan="11"><code>STOP_ON_FAILURE</code></td>
        <td rowspan="6"><code>DO_NOTHING</code></td>
        <td rowspan="3">Within Limits</td>
        <td>✅ <code>SUCCESS</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right><code>200</code></td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>➖ <code>NOT_ATTEMPTED</code></td>
        <td align=right><code>400</code></td>
    </tr>
    <tr>
        <td>✅ <code>SUCCESS</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right><code>409</code></td>
    </tr>
    <tr>
        <td rowspan="3">Exceeds Limits</td>
        <td>✅ <code>SUCCESS</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right>N/A</td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>➖ <code>NOT_ATTEMPTED</code></td>
        <td align=right>N/A</td>
    </tr>
    <tr>
        <td>✅ <code>SUCCESS</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right>N/A</td>
    </tr>
    <tr>
        <td rowspan="5"><code>CANCEL_ONLY</code></td>
        <td rowspan="3">Within Limits</td>
        <td>✅ <code>SUCCESS</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right><code>200</code></td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>➖ <code>NOT_ATTEMPTED</code></td>
        <td align=right><code>400</code></td>
    </tr>
    <tr>
        <td>✅ <code>SUCCESS</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right><code>409</code></td>
    </tr>
    <tr>
        <td rowspan="2">Exceeds Limits</td>
        <td>❌ <code>FAILURE</code></td>
        <td>➖ <code>NOT_ATTEMPTED</code></td>
        <td align=right><code>429</code></td>
    </tr>
    <tr>
        <td>✅ <code>SUCCESS</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right><code>429</code></td>
    </tr>
    <tr>
        <td rowspan="16"><code>ALLOW_FAILURE</code></td>
        <td rowspan="8"><code>DO_NOTHING</code></td>
        <td rowspan="4">Within Limits</td>
        <td>✅ <code>SUCCESS</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right><code>200</code></td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right><code>400</code></td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right><code>409</code></td>
    </tr>
    <tr>
        <td>✅ <code>SUCCESS</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right><code>409</code></td>
    </tr>
    <tr>
    <td rowspan="4">Exceeds Limits</td>
        <td>✅ <code>SUCCESS</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right>N/A</td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right>N/A</td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right>N/A</td>
    </tr>
    <tr>
        <td>✅ <code>SUCCESS</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right>N/A</td>
    </tr>
    <tr>
        <td rowspan="8"><CODE>CANCEL_ONLY</CODE></td>
        <td rowspan="4">Within Limits</td>
        <td>✅ <code>SUCCESS</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right><code>200</code></td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right><code>400</code></td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right><code>409</code></td>
    </tr>
    <tr>
        <td>✅ <code>SUCCESS</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right><code>409</code></td>
    </tr>
    <tr>
        <td rowspan="4">Exceeds Limits</td>
        <td>✅ <code>SUCCESS</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right><code>200</code></td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right><code>400</code></td>
    </tr>
    <tr>
        <td>❌ <code>FAILURE</code></td>
        <td>✅ <code>SUCCESS</code></td>
        <td align=right>N/A</td>
    </tr>
    <tr>
        <td>✅ <code>SUCCESS</code></td>
        <td>❌ <code>FAILURE</code></td>
        <td align=right><code>409</code></td>
    </tr>
</tbody>
</table>

Notes:

* If both `cancelOrderId` and `cancelOrigClientOrderId` parameters are provided, the `cancelOrderId` is searched first, then the `cancelOrigClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected.

* `cancelNewClientOrderId` will replace `clientOrderId` of the canceled order, freeing it up for new orders.

* `newClientOrderId` specifies `clientOrderId` value for the placed order.

  A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired.

  The new order can reuse old `clientOrderId` of the canceled order.

* This cancel-replace operation is **not transactional**.

  If one operation succeeds but the other one fails, the successful operation is still executed.

  For example, in `STOP_ON_FAILURE` mode, if the new order placement fails, the old order is still canceled.

* Filters and order count limits are evaluated before cancellation and order placement occurs.

* If new order placement is not attempted, your order count is still incremented.

* Like [`order.cancel`](#order-cancel), if you cancel an individual order from an order list, the entire order list is canceled.

* The performance for canceling an order (single cancel or as part of a cancel-replace) is always better when only `orderId` is sent. Sending `origClientOrderId` or both `orderId` + `origClientOrderId` will be slower.

**Response:**

If both cancel and placement succeed, you get the following response with `"status": 200`:

```javascript
{
    "id": "99de1036-b5e2-4e0f-9b5c-13d751c93a1a",
    "status": 200,
    "result": {
        "cancelResult": "SUCCESS",
        "newOrderResult": "SUCCESS",
        // Format is identical to "order.cancel" format.
        // Some fields are optional and are included only for orders that set them.
        "cancelResponse": {
            "symbol": "BTCUSDT",
            "origClientOrderId": "4d96324ff9d44481926157", // cancelOrigClientOrderId from request
            "orderId": 125690984230,
            "orderListId": -1,
            "clientOrderId": "91fe37ce9e69c90d6358c0",     // cancelNewClientOrderId from request
            "transactTime": 1684804350068,
            "price": "23450.00000000",
            "origQty": "0.00847000",
            "executedQty": "0.00001000",
            "origQuoteOrderQty": "0.000000",
            "cummulativeQuoteQty": "0.23450000",
            "status": "CANCELED",
            "timeInForce": "GTC",
            "type": "LIMIT",
            "side": "SELL",
            "selfTradePreventionMode": "NONE",
            "icebergQty": "0.00000000",                    // Appears only if the parameter icebergQty was sent in the request.
            "preventedMatchId": 0,                         // Appears only if the order expired due to STP.
            "preventedQuantity": "1.200000",               // Order quantity that expired due to STP.
            "stopPrice": "0.00000000",                     // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
            "strategyId": 1,                               // Appears only if the strategyId parameter was provided upon order placement.
            "strategyType": 1000000,                       // Appears only if the strategyType parameter was provided upon order placement.
            "trailingDelta": 10,                           // Delta price change required before order activation.
            "trailingTime": -1,                            // Time when the trailing order is now active and tracking price changes.
            "usedSor": true,                               // Field that determines whether order used SOR.
            "workingFloor": "SOR",                         // Determines whether the order is being filled by the SOR or by the order book.
            "pegPriceType": "PRIMARY_PEG",                 // Price peg type. Only for pegged orders.
            "pegOffsetType": "PRICE_LEVEL",                // Price peg offset type. Only for pegged orders, if requested.
            "pegOffsetValue": 5,                           // Price peg offset value. Only for pegged orders, if requested.
            "peggedPrice": "87523.83710000",               // Current price order is pegged at. Only for pegged orders, once determined.
            "expiryReason": "INSUFFICIENT_LIQUIDITY"       // Cause of the order's expiration. Appears when an order has expired.
        },
        // Format is identical to "order.place" format, affected by "newOrderRespType".
        // Some fields are optional and are included only for orders that set them.
        "newOrderResponse": {
            "symbol": "BTCUSDT",
            "orderId": 12569099453,
            "orderListId": -1,
            "clientOrderId": "bX5wROblo6YeDwa9iTLeyY",
            "transactTime": 1660813156959,
            "price": "23416.10000000",
            "origQty": "0.00847000",
            "executedQty": "0.00000000",
            "origQuoteOrderQty": "0.000000",
            "cummulativeQuoteQty": "0.00000000",
            "status": "NEW",
            "timeInForce": "GTC",
            "type": "LIMIT",
            "side": "SELL",
            "selfTradePreventionMode": "NONE",
            "icebergQty": "0.00000000",              // Appears only if the parameter icebergQty was sent in the request.
            "preventedMatchId": 0,                   // Appears only if the order expired due to STP.
            "preventedQuantity": "1.200000",         // Order quantity that expired due to STP.
            "stopPrice": "0.00000000",               // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
            "strategyId": 1,                         // Appears only if the strategyId parameter was provided upon order placement.
            "strategyType": 1000000,                 // Appears only if the strategyType parameter was provided upon order placement.
            "trailingDelta": 10,                     // Delta price change required before order activation.
            "trailingTime": -1,                      // Time when the trailing order is now active and tracking price changes.
            "usedSor": true,                         // Field that determines whether order used SOR.
            "workingFloor": "SOR",                   // Determines whether the order is being filled by the SOR or by the order book.
            "pegPriceType": "PRIMARY_PEG",           // Price peg type. Only for pegged orders.
            "pegOffsetType": "PRICE_LEVEL",          // Price peg offset type. Only for pegged orders, if requested.
            "pegOffsetValue": 5,                     // Price peg offset value. Only for pegged orders, if requested.
            "peggedPrice": "87523.83710000",         // Current price order is pegged at. Only for pegged orders, once determined.
            "expiryReason": "INSUFFICIENT_LIQUIDITY" // Cause of the order's expiration. Appears when an order has expired.
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

In `STOP_ON_FAILURE` mode, failed order cancellation prevents new order from being placed
and returns the following response with `"status": 400`:

```javascript
{
    "id": "27e1bf9f-0539-4fb0-85c6-06183d36f66c",
    "status": 400,
    "error": {
        "code": -2022,
        "msg": "Order cancel-replace failed.",
        "data": {
            "cancelResult": "FAILURE",
            "newOrderResult": "NOT_ATTEMPTED",
            "cancelResponse": {
                "code": -2011,
                "msg": "Unknown order sent."
            },
            "newOrderResponse": null
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

If both operations fail, response will have `"status": 400`:

```javascript
{
    "id": "3b3ac45c-1002-4c7d-88e8-630c408ecd87",
    "status": 400,
    "error": {
        "code": -2022,
        "msg": "Order cancel-replace failed.",
        "data": {
            "cancelResult": "FAILURE",
            "newOrderResult": "FAILURE",
            "cancelResponse": {
                "code": -2011,
                "msg": "Unknown order sent."
            },
            "newOrderResponse": {
                "code": -2010,
                "msg": "Order would immediately match and take."
            }
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

If cancel-replace mode allows failure and one of the operations fails,
you get a response with `"status": 409`,
and the `"data"` field detailing which operation succeeded, which failed, and why.

Cancellation succeeded, new order placement failed:

```javascript
{
    "id": "b220edfe-f3c4-4a3a-9d13-b35473783a25",
    "status": 409,
    "error": {
        "code": -2021,
        "msg": "Order cancel-replace partially failed.",
        "data": {
            "cancelResult": "SUCCESS",
            "newOrderResult": "FAILURE",
            "cancelResponse": {
                "symbol": "BTCUSDT",
                "origClientOrderId": "4d96324ff9d44481926157", // cancelOrigClientOrderId from request
                "orderId": 125690984230,
                "orderListId": -1,
                "clientOrderId": "91fe37ce9e69c90d6358c0",     // cancelNewClientOrderId from request
                "transactTime": 1684804350068,
                "price": "23450.00000000",
                "origQty": "0.00847000",
                "executedQty": "0.00001000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.23450000",
                "status": "CANCELED",
                "timeInForce": "GTC",
                "type": "LIMIT",
                "side": "SELL",
                "selfTradePreventionMode": "NONE"
            },
            "newOrderResponse": {
                "code": -2010,
                "msg": "Order would immediately match and take."
            }
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

Cancellation failed, new order placement succeeded:

```javascript
{
    "id": "ce641763-ff74-41ac-b9f7-db7cbe5e93b1",
    "status": 409,
    "error": {
        "code": -2021,
        "msg": "Order cancel-replace partially failed.",
        "data": {
            "cancelResult": "FAILURE",
            "newOrderResult": "SUCCESS",
            "cancelResponse": {
                "code": -2011,
                "msg": "Unknown order sent."
            },
            "newOrderResponse": {
                "symbol": "BTCUSDT",
                "orderId": 12569099453,
                "orderListId": -1,
                "clientOrderId": "bX5wROblo6YeDwa9iTLeyY",
                "transactTime": 1660813156959,
                "price": "23416.10000000",
                "origQty": "0.00847000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "NEW",
                "timeInForce": "GTC",
                "type": "LIMIT",
                "side": "SELL",
                "workingTime": 1669693344508,
                "fills": [],
                "selfTradePreventionMode": "NONE"
            }
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 1
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 1
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

If `orderRateLimitExceededMode` is `CANCEL_ONLY` regardless of `cancelReplaceMode`, and you have exceeded your unfilled order count, you will get status `409` with the following error:

```javascript
{
    "id": "3b3ac45c-1002-4c7d-88e8-630c408ecd87",
    "status": 409,
    "error": {
        "code": -2021,
        "msg": "Order cancel-replace partially failed.",
        "data": {
            "cancelResult": "SUCCESS",
            "newOrderResult": "FAILURE",
            "cancelResponse": {
                "symbol": "LTCBNB",
                "origClientOrderId": "GKt5zzfOxRDSQLveDYCTkc", // cancelOrigClientOrderId from request
                "orderId": 64,
                "orderListId": -1,
                "clientOrderId": "loehOJF3FjoreUBDmv739R",     // cancelNewClientOrderId from request
                "transactTime": 1715779007228,
                "price": "1.00",
                "origQty": "10.00000000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00",
                "status": "CANCELED",
                "timeInForce": "GTC",
                "type": "LIMIT",
                "side": "SELL",
                "selfTradePreventionMode": "NONE"
            },
            "newOrderResponse": {
                "code": -1015,
                "msg": "Too many new orders; current limit is 50 orders per 10 SECOND."
            }
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 50
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 50
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

If `orderRateLimitExceededMode` is `DO_NOTHING` regardless of `cancelReplaceMode`, and you have exceeded your unfilled order count, you will get status `429` with the following error:

```javascript
{
    "id": "3b3ac45c-1002-4c7d-88e8-630c408ecd87",
    "status": 429,
    "error": {
        "code": -1015,
        "msg": "Too many new orders; current limit is 50 orders per 10 SECOND."
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 50
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 50
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="order.amend.keepPriority"></a>
<a id="order-amend-keepPriority"></a>
<a id="order-amend-keep-priority"></a>
<a id="order-amend-keeppriority"></a>

### Order Amend Keep Priority (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "order.amend.keepPriority",
    "params": {
        "symbol": "BTCUSDT",
        "origClientOrderId": "my_test_order1",
        "newQty": "5",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
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](faqs/order_amend_keep_priority.md) to learn more.

**Weight:**
4

**Unfilled Order Count:**
0

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`orderId` | LONG | NO | `orderId` or `origClientOrderId` must be sent
`origClientOrderId` | STRING | NO | `orderId` or `origClientOrderId` must be sent
`newClientOrderId` | STRING | NO | The new client order ID for the order after being amended. <br> If not sent, one will be randomly generated. <br> It is possible to reuse the current clientOrderId by sending it as the `newClientOrderId`.
`newQty` | DECIMAL | YES | `newQty` must be greater than 0 and less than the order's quantity.
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

**Response:**

Response for a single order:

```javascript
{
    "id": "56374a46-3061-486b-a311-89ee972eb648",
    "status": 200,
    "result": {
        "transactTime": 1741923284382,
        "executionId": 16,
        "amendedOrder": {
            "symbol": "BTCUSDT",
            "orderId": 12,
            "orderListId": -1,
            "origClientOrderId": "my_test_order1",
            "clientOrderId": "4zR9HFcEq8gM1tWUqPEUHc",
            "price": "5.00000000",
            "qty": "5.00000000",
            "executedQty": "0.00000000",
            "preventedQty": "0.00000000",
            "quoteOrderQty": "0.00000000",
            "cumulativeQuoteQty": "0.00000000",
            "status": "NEW",
            "timeInForce": "GTC",
            "type": "LIMIT",
            "side": "BUY",
            "workingTime": 1741923284364,
            "selfTradePreventionMode": "NONE"
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

Response for an order which is part of an Order list:

```javascript
{
    "id": "56374b46-3061-486b-a311-89ee972eb648",
    "status": 200,
    "result": {
        "transactTime": 1741924229819,
        "executionId": 60,
        "amendedOrder": {
            "symbol": "BTUCSDT",
            "orderId": 23,
            "orderListId": 4,
            "origClientOrderId": "my_pending_order",
            "clientOrderId": "xbxXh5SSwaHS7oUEOCI88B",
            "price": "1.00000000",
            "qty": "5.00000000",
            "executedQty": "0.00000000",
            "preventedQty": "0.00000000",
            "quoteOrderQty": "0.00000000",
            "cumulativeQuoteQty": "0.00000000",
            "status": "NEW",
            "timeInForce": "GTC",
            "type": "LIMIT",
            "side": "BUY",
            "workingTime": 1741924204920,
            "selfTradePreventionMode": "NONE",
            "icebergQty": "0.00000000",              // Appears only if the parameter icebergQty was sent in the request.
            "preventedMatchId": 0,                   // Appears only if the order expired due to STP.
            "preventedQuantity": "1.200000",         // Order quantity that expired due to STP.
            "stopPrice": "0.00000000",               // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
            "strategyId": 1,                         // Appears only if the strategyId parameter was provided upon order placement.
            "strategyType": 1000000,                 // Appears only if the strategyType parameter was provided upon order placement.
            "trailingDelta": 10,                     // Delta price change required before order activation.
            "trailingTime": -1,                      // Time when the trailing order is now active and tracking price changes.
            "usedSor": true,                         // Field that determines whether order used SOR.
            "workingFloor": "SOR",                   // Determines whether the order is being filled by the SOR or by the order book.
            "pegPriceType": "PRIMARY_PEG",           // Price peg type. Only for pegged orders.
            "pegOffsetType": "PRICE_LEVEL",          // Price peg offset type. Only for pegged orders, if requested.
            "pegOffsetValue": 5,                     // Price peg offset value. Only for pegged orders, if requested.
            "peggedPrice": "87523.83710000",         // Current price order is pegged at. Only for pegged orders, once determined.
            "expiryReason": "INSUFFICIENT_LIQUIDITY" // Cause of the order's expiration. Appears when an order has expired.
        },
        "listStatus": {
            "orderListId": 4,
            "contingencyType": "OTO",
            "listOrderStatus": "EXECUTING",
            "listClientOrderId": "8nOGLLawudj1QoOiwbroRH",
            "symbol": "BTCUSDT",
            "orders": [
                {
                    "symbol": "BTCUSDT",
                    "orderId": 22,
                    "clientOrderId": "g04EWsjaackzedjC9wRkWD"
                },
                {
                    "symbol": "BTCUSDT",
                    "orderId": 23,
                    "clientOrderId": "xbxXh5SSwaHS7oUEOCI88B"
                }
            ]
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="openOrders.cancelAll"></a>
<a id="openOrders-cancelAll"></a>
<a id="open-orders-cancel-all"></a>
<a id="openorders-cancelall"></a>

### Cancel open orders (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "openOrders.cancelAll",
    "params": {
        "symbol": "BNBUSDT",
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Cancel all open orders on a symbol.
This includes orders that are part of an order list.

**Weight:**
1

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

**Response:**
```javascript
{
    "id": "778f938f-9041-4b88-9914-efbf64eeacc8",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "origClientOrderId": "4d96324ff9d44481926157",
            "orderId": 12569099453,
            "orderListId": -1,
            "clientOrderId": "91fe37ce9e69c90d6358c0",
            "transactTime": 1684804350068,
            "price": "23416.10000000",
            "origQty": "0.00847000",
            "executedQty": "0.00001000",
            "origQuoteOrderQty": "0.000000",
            "cummulativeQuoteQty": "0.23416100",
            "status": "CANCELED",
            "timeInForce": "GTC",
            "type": "LIMIT",
            "side": "SELL",
            "stopPrice": "0.00000000",  // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
            "trailingDelta": 0,         // Delta price change required before order activation.
            "trailingTime": -1,         // Time when the trailing order is now active and tracking price changes.
            "icebergQty": "0.00000000", // Appears only if the parameter icebergQty was sent in the request.
            "strategyId": 37463720,     // Appears only if the strategyId parameter was provided upon order placement.
            "strategyType": 1000000,    // Appears only if the strategyType parameter was provided upon order placement.
            "selfTradePreventionMode": "NONE"
        },
        {
            "orderListId": 19431,
            "contingencyType": "OCO",
            "listStatusType": "ALL_DONE",
            "listOrderStatus": "ALL_DONE",
            "listClientOrderId": "iuVNVJYYrByz6C4yGOPPK0",
            "transactionTime": 1660803702431,
            "symbol": "BTCUSDT",
            "orders": [
                {
                    "symbol": "BTCUSDT",
                    "orderId": 12569099453,
                    "clientOrderId": "bX5wROblo6YeDwa9iTLeyY"
                },
                {
                    "symbol": "BTCUSDT",
                    "orderId": 12569099454,
                    "clientOrderId": "Tnu2IP0J5Y4mxw3IATBfmW"
                }
            ],
            "orderReports": [
                {
                    "symbol": "BTCUSDT",
                    "origClientOrderId": "bX5wROblo6YeDwa9iTLeyY",
                    "orderId": 12569099453,
                    "orderListId": 19431,
                    "clientOrderId": "OFFXQtxVFZ6Nbcg4PgE2DA",
                    "transactTime": 1684804350068,
                    "price": "23450.50000000",
                    "origQty": "0.00850000",
                    "executedQty": "0.00000000",
                    "origQuoteOrderQty": "0.000000",
                    "cummulativeQuoteQty": "0.00000000",
                    "status": "CANCELED",
                    "timeInForce": "GTC",
                    "type": "STOP_LOSS_LIMIT",
                    "side": "BUY",
                    "stopPrice": "23430.00000000", // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
                    "selfTradePreventionMode": "NONE"
                },
                {
                    "symbol": "BTCUSDT",
                    "origClientOrderId": "Tnu2IP0J5Y4mxw3IATBfmW",
                    "orderId": 12569099454,
                    "orderListId": 19431,
                    "clientOrderId": "OFFXQtxVFZ6Nbcg4PgE2DA",
                    "transactTime": 1684804350068,
                    "price": "23400.00000000",
                    "origQty": "0.00850000",
                    "executedQty": "0.00000000",
                    "origQuoteOrderQty": "0.000000",
                    "cummulativeQuoteQty": "0.00000000",
                    "status": "CANCELED",
                    "timeInForce": "GTC",
                    "type": "LIMIT_MAKER",
                    "side": "BUY",
                    "selfTradePreventionMode": "NONE"
                }
            ]
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="orderList.place"></a>
<a id="orderList-place"></a>
<a id="order-list-place"></a>
<a id="orderlist-place"></a>
<a id="order-lists"></a>

### Place new OCO - Deprecated (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "orderList.place",
    "params": {
        "symbol": "BTCUSDT",
        "side": "SELL",
        "price": "23420.00000000",
        "quantity": "0.00650000",
        "stopPrice": "23410.00000000",
        "stopLimitPrice": "23405.00000000",
        "stopLimitTimeInForce": "GTC",
        "newOrderRespType": "RESULT",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Send in a new one-cancels-the-other (OCO) pair:
`LIMIT_MAKER` + `STOP_LOSS`/`STOP_LOSS_LIMIT` orders (called *legs*),
where activation of one order immediately cancels the other.

This adds 1 order to `EXCHANGE_MAX_ORDERS` filter and the `MAX_NUM_ORDERS` filter

**Weight:**
1

**Unfilled Order Count:**
1

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`side` | ENUM | YES | Please see [Enums](enums.md#side) for supported values.
`price` | DECIMAL | YES |
`quantity` | DECIMAL | YES |
`listClientOrderId` | STRING | NO | A unique Id for the entire orderList
`limitClientOrderId` | STRING | NO | A unique Id for the limit order
`limitIcebergQty` | DECIMAL | NO | Used to make the `LIMIT_MAKER` leg an iceberg order.
`limitStrategyId` | LONG | NO |
`limitStrategyType` | INT | NO | The value cannot be less than `1000000`.
`stopPrice` | DECIMAL | NO |
`trailingDelta` | INT | NO |
`stopClientOrderId` | STRING | NO | A unique Id for the stop loss/stop loss limit leg
`stopLimitPrice` | DECIMAL | NO | If provided, `stopLimitTimeInForce` is required.
`stopLimitTimeInForce` | ENUM | NO | Valid values are `GTC`/`FOK`/`IOC`
`stopIcebergQty` | DECIMAL | NO | Used with `STOP_LOSS_LIMIT` leg to make an iceberg order.
`stopStrategyId` | LONG | NO |
`stopStrategyType` | INT | NO | The value cannot be less than `1000000`.
`newOrderRespType` | ENUM | NO | Format of the JSON response. Supported values: [Order Response Type](enums.md#orderresponsetype)
`selfTradePreventionMode` | ENUM | NO | The allowed values are dependent on what is configured on the symbol. Supported values: [STP Modes](enums.md#stpmodes)
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

Notes:

* `listClientOrderId` parameter specifies `listClientOrderId` for the OCO pair.

  A new OCO with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired.

  `listClientOrderId` is distinct from `clientOrderId` of individual orders.

* `limitClientOrderId` and `stopClientOrderId` specify `clientOrderId` values for both legs of the OCO.

  A new order with the same `clientOrderId` is accepted only when the previous one is filled or expired.

* Price restrictions on the legs:

  | `side` | Price relation |
  | ------ | -------------- |
  | `BUY`  | `price` < market price < `stopPrice` |
  | `SELL` | `price` > market price > `stopPrice` |

* Both legs have the same `quantity`.

  However, you can set different iceberg quantity for individual legs.

  If `stopIcebergQty` is used, `stopLimitTimeInForce` must be `GTC`.

* `trailingDelta` applies only to the `STOP_LOSS`/`STOP_LOSS_LIMIT` leg of the OCO.

**Response:**
```javascript
{
    "id": "57833dc0-e3f2-43fb-ba20-46480973b0aa",
    "status": 200,
    "result": {
        "orderListId": 1274512,
        "contingencyType": "OCO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": "08985fedd9ea2cf6b28996",
        "transactionTime": 1660801713793,
        "symbol": "BTCUSDT",
        "orders": [
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138901,
                "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138902,
                "clientOrderId": "jLnZpj5enfMXTuhKB1d0us"
            }
        ],
        "orderReports": [
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138901,
                "orderListId": 1274512,
                "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU",
                "transactTime": 1660801713793,
                "price": "23410.00000000",
                "origQty": "0.00650000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "NEW",
                "timeInForce": "GTC",
                "type": "STOP_LOSS_LIMIT",
                "side": "SELL",
                "stopPrice": "23405.00000000", // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
                "workingTime": -1,
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138902,
                "orderListId": 1274512,
                "clientOrderId": "jLnZpj5enfMXTuhKB1d0us",
                "transactTime": 1660801713793,
                "price": "23420.00000000",
                "origQty": "0.00650000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "NEW",
                "timeInForce": "GTC",
                "type": "LIMIT_MAKER",
                "side": "SELL",
                "workingTime": 1660801713793,
                "selfTradePreventionMode": "NONE"
            }
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 2
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 2
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

<a id="orderList.place.oco"></a>
<a id="orderList-place-oco"></a>
<a id="order-list-place-oco"></a>
<a id="orderlist-place-oco"></a>

### Place new Order list - OCO (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "orderList.place.oco",
    "params": {
        "symbol": "LTCBNB",
        "side": "BUY",
        "quantity": 1,
        "aboveType": "STOP_LOSS_LIMIT",
        "abovePrice": "1.5",
        "aboveStopPrice": "1.50000001",
        "aboveTimeInForce": "GTC",
        "belowType": "LIMIT_MAKER",
        "belowPrice": "1.49999999",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
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` `price` < Last Traded Price < `STOP_LOSS/STOP_LOSS_LIMIT` `stopPrice`
    * `TAKE_PROFIT stopPrice` > Last Traded Price > `STOP_LOSS/STOP_LOSS_LIMIT stopPrice`
*  OCOs add **2 orders** to the `EXCHANGE_MAX_ORDERS` filter and `MAX_NUM_ORDERS` filter.

**Weight:**
1

**Unfilled Order Count:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`listClientOrderId` | STRING | NO | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `aboveClientOrderId` and the `belowClientOrderId`.
`side` | ENUM | YES | `BUY` or `SELL`
`quantity` | DECIMAL | YES | Quantity for both orders of the order list.
`aboveType` | ENUM | YES |
`aboveClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the above order. Automatically generated if not sent.
`aboveIcebergQty` | LONG | NO | Note that this can only be used if `aboveTimeInForce` is `GTC`.
`abovePrice` | DECIMAL | NO | Can be used if `aboveType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price.
`aboveStopPrice` | DECIMAL | NO | Can be used if `aboveType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `aboveStopPrice` or `aboveTrailingDelta` or both, must be specified.
`aboveTrailingDelta` | LONG | NO | See [Trailing Stop order FAQ](faqs/trailing-stop-faq.md)
`aboveTimeInForce` | ENUM | NO | Required if `aboveType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
`aboveStrategyId` | LONG | NO | Arbitrary numeric value identifying the above order within an order strategy.
`aboveStrategyType` | INT | NO | Arbitrary numeric value identifying the above order strategy. Values smaller than `1000000` are reserved and cannot be used.
`abovePegPriceType` | ENUM | NO | `PRIMARY_PEG` or `MARKET_PEG`. See [Pegged Orders](faqs/pegged_orders.md)
`abovePegOffsetType` | ENUM | NO |
`abovePegOffsetValue` | INT | NO | Maximum: 100.
`belowType` | ENUM | YES | Supported values: `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`
`belowClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the below order. Automatically generated if not sent.
`belowIcebergQty` | LONG | NO | Note that this can only be used if `belowTimeInForce` is `GTC`.
`belowPrice` | DECIMAL | NO | Can be used if `belowType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price.
`belowStopPrice` | DECIMAL | NO | Can be used if `belowType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `belowStopPrice` or `belowTrailingDelta` or both, must be specified.
`belowTrailingDelta` | LONG | NO | See [Trailing Stop order FAQ](faqs/trailing-stop-faq.md)
`belowTimeInForce` | ENUM | NO | Required if `belowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
`belowStrategyId` | LONG | NO | Arbitrary numeric value identifying the below order within an order strategy.
`belowStrategyType` | INT | NO | Arbitrary numeric value identifying the below order strategy. Values smaller than `1000000` are reserved and cannot be used.
`belowPegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`belowPegOffsetType` | ENUM | NO |
`belowPegOffsetValue` | INT | NO | Maximum: 100.
`newOrderRespType` | ENUM | NO | Select response format: `ACK`, `RESULT`, `FULL`.
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](enums.md#stpmodes)
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

**Response:**
```javascript
{
    "id": "56374a46-3261-486b-a211-99ed972eb648",
    "status": 200,
    "result": {
        "orderListId": 2,
        "contingencyType": "OCO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": "cKPMnDCbcLQILtDYM4f4fX",
        "transactionTime": 1711062760648,
        "symbol": "LTCBNB",
        "orders": [
            {
                "symbol": "LTCBNB",
                "orderId": 2,
                "clientOrderId": "0m6I4wfxvTUrOBSMUl0OPU"
            },
            {
                "symbol": "LTCBNB",
                "orderId": 3,
                "clientOrderId": "Z2IMlR79XNY5LU0tOxrWyW"
            }
        ],
        "orderReports": [
            {
                "symbol": "LTCBNB",
                "orderId": 2,
                "orderListId": 2,
                "clientOrderId": "0m6I4wfxvTUrOBSMUl0OPU",
                "transactTime": 1711062760648,
                "price": "1.50000000",
                "origQty": "1.000000",
                "executedQty": "0.000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "NEW",
                "timeInForce": "GTC",
                "type": "STOP_LOSS_LIMIT",
                "side": "BUY",
                "stopPrice": "1.50000001", // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
                "workingTime": -1,
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "LTCBNB",
                "orderId": 3,
                "orderListId": 2,
                "clientOrderId": "Z2IMlR79XNY5LU0tOxrWyW",
                "transactTime": 1711062760648,
                "price": "1.49999999",
                "origQty": "1.000000",
                "executedQty": "0.000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "NEW",
                "timeInForce": "GTC",
                "type": "LIMIT_MAKER",
                "side": "BUY",
                "workingTime": 1711062760648,
                "selfTradePreventionMode": "NONE"
            }
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 2
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 2
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

<a id="orderList.place.oto"></a>
<a id="orderList-place-oto"></a>
<a id="order-list-place-oto"></a>
<a id="orderlist-place-oto"></a>

### Place new Order list - OTO (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "orderList.place.oto",
    "params": {
        "symbol": "LTCBNB",
        "workingType": "LIMIT",
        "workingSide": "SELL",
        "workingPrice": 1,
        "workingQuantity": 1,
        "workingTimeInForce": "GTC",
        "pendingType": "MARKET",
        "pendingSide": "BUY",
        "pendingQuantity": 1,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Places 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

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`listClientOrderId` | STRING | NO | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`.
`newOrderRespType` | ENUM | NO | Format of the JSON response. Supported values: [Order Response Type](enums.md#orderresponsetype)
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](enums.md#stpmodes)
`workingType` | ENUM | YES | Supported values: `LIMIT`, `LIMIT_MAKER`
`workingSide` | ENUM | YES | Supported values: [Order Side](enums.md#side)
`workingClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the working order. Automatically generated if not sent.
`workingPrice` | DECIMAL | YES |
`workingQuantity` | DECIMAL | YES | Sets the quantity for the working order.
`workingIcebergQty` | DECIMAL | NO | This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`.
`workingTimeInForce` | ENUM | NO | Supported values: [Time In Force](enums.md#timeinforce)
`workingStrategyId` | LONG | NO | Arbitrary numeric value identifying the working order within an order strategy.
`workingStrategyType` | INT | NO | Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used.
`workingPegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`workingPegOffsetType` | ENUM | NO |
`workingPegOffsetValue` | INT | NO | Maximum: 100.
`pendingType` | ENUM | YES | Supported values: [Order Types](enums.md#ordertypes). Note that `MARKET` orders using `quoteOrderQty` are not supported.
`pendingSide` | ENUM | YES | Supported values: [Order Side](enums.md#side)
`pendingClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the pending order. Automatically generated if not sent.
`pendingPrice` | DECIMAL | NO |
`pendingStopPrice` | DECIMAL | NO |
`pendingTrailingDelta` | DECIMAL | NO |
`pendingQuantity` | DECIMAL | YES | Sets the quantity for the pending order.
`pendingIcebergQty` | DECIMAL | NO | This can only be used if `pendingTimeInForce` is `GTC` or if `pendingType` is `LIMIT_MAKER`.
`pendingTimeInForce` | ENUM | NO | Supported values: [Time In Force](enums.md#timeinforce)
`pendingStrategyId` | LONG | NO | Arbitrary numeric value identifying the pending order within an order strategy.
`pendingStrategyType` | INT | NO | Arbitrary numeric value identifying the pending order strategy. Values smaller than `1000000` are reserved and cannot be used.
`pendingPegOffsetType` | ENUM | NO |
`pendingPegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`pendingPegOffsetValue` | INT | NO | Maximum: 100.
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

<a id="mandatory-parameters-based-on-pendingtype-or-workingtype"></a>

**Mandatory parameters based on `pendingType` or `workingType`**

Depending on the `pendingType` or `workingType`, some optional parameters will become mandatory.

|Type                                                  |Additional mandatory parameters|Additional information|
|----                                                  |----                           |------
|`workingType` = `LIMIT`                               |`workingTimeInForce`           |
|`pendingType` = `LIMIT`                                |`pendingPrice`, `pendingTimeInForce`          |
|`pendingType` = `STOP_LOSS` or `TAKE_PROFIT`           |`pendingStopPrice` and/or `pendingTrailingDelta`|
|`pendingType` =`STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`|`pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce`|

**Response:**
```javascript
{
    "id": "1712544395950",
    "status": 200,
    "result": {
        "orderListId": 626,
        "contingencyType": "OTO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": "KA4EBjGnzvSwSCQsDdTrlf",
        "transactionTime": 1712544395981,
        "symbol": "LTCBNB",
        "orders": [
            {
                "symbol": "LTCBNB",
                "orderId": 13,
                "clientOrderId": "YiAUtM9yJjl1a2jXHSp9Ny"
            },
            {
                "symbol": "LTCBNB",
                "orderId": 14,
                "clientOrderId": "9MxJSE1TYkmyx5lbGLve7R"
            }
        ],
        "orderReports": [
            {
                "symbol": "LTCBNB",
                "orderId": 13,
                "orderListId": 626,
                "clientOrderId": "YiAUtM9yJjl1a2jXHSp9Ny",
                "transactTime": 1712544395981,
                "price": "1.000000",
                "origQty": "1.000000",
                "executedQty": "0.000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.000000",
                "status": "NEW",
                "timeInForce": "GTC",
                "type": "LIMIT",
                "side": "SELL",
                "workingTime": 1712544395981,
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "LTCBNB",
                "orderId": 14,
                "orderListId": 626,
                "clientOrderId": "9MxJSE1TYkmyx5lbGLve7R",
                "transactTime": 1712544395981,
                "price": "0.000000",
                "origQty": "1.000000",
                "executedQty": "0.000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.000000",
                "status": "PENDING_NEW",
                "timeInForce": "GTC",
                "type": "MARKET",
                "side": "BUY",
                "workingTime": -1,
                "selfTradePreventionMode": "NONE"
            }
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 10000000,
            "count": 10
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 1000,
            "count": 38
        }
    ]
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="orderList.place.otoco"></a>
<a id="orderList-place-otoco"></a>
<a id="order-list-place-otoco"></a>
<a id="orderlist-place-otoco"></a>

### Place new Order list - OTOCO (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "orderList.place.otoco",
    "params": {
        "symbol": "LTCBNB",
        "workingType": "LIMIT",
        "workingSide": "BUY",
        "workingPrice": 1.5,
        "workingQuantity": 1,
        "workingTimeInForce": "GTC",
        "pendingSide": "SELL",
        "pendingQuantity": 5,
        "pendingAboveType": "STOP_LOSS",
        "pendingAboveStopPrice": 0.5,
        "pendingBelowType": "LIMIT_MAKER",
        "pendingBelowPrice": 5,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
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](#order-list-place-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](web-socket-api.md#place-new-order-list---oco-trade).
* OTOCOs add **3 orders** to the `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter.

**Weight:**
1

**Unfilled Order Count:**
3

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`listClientOrderId` | STRING | NO | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId`, `pendingAboveClientOrderId`, and the `pendingBelowClientOrderId`.
`newOrderRespType` | ENUM | NO | Format of the JSON response. Supported values: [Order Response Type](enums.md#orderresponsetype)
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](enums.md#stpmodes)
`workingType` | ENUM | YES | Supported values: `LIMIT`, `LIMIT_MAKER`
`workingSide` | ENUM | YES | Supported values: [Order Side](enums.md#side)
`workingClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the working order. Automatically generated if not sent.
`workingPrice` | DECIMAL | YES |
`workingQuantity` | DECIMAL | YES | Sets the quantity for the working order.
`workingIcebergQty` | DECIMAL | NO | This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`.
`workingTimeInForce` | ENUM | NO | Supported values: [Time In Force](enums.md#timeinforce)
`workingStrategyId` | LONG | NO | Arbitrary numeric value identifying the working order within an order strategy.
`workingStrategyType` | INT | NO | Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used.
`workingPegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`workingPegOffsetType` | ENUM | NO |
`workingPegOffsetValue` | INT | NO | Maximum: 100.
`pendingSide` | ENUM | YES | Supported values: [Order Side](enums.md#side)
`pendingQuantity` | DECIMAL | YES | Sets the quantity for the pending orders.
`pendingAboveType` | ENUM | YES | Supported values: `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`
`pendingAboveClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent.
`pendingAbovePrice` | DECIMAL | NO | Can be used if `pendingAboveType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price.
`pendingAboveStopPrice` | DECIMAL | NO | Can be used if `pendingAboveType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`.
`pendingAboveTrailingDelta` | DECIMAL | NO | See [Trailing Stop order FAQ](faqs/trailing-stop-faq.md)
`pendingAboveIcebergQty` | DECIMAL | NO | This can only be used if `pendingAboveTimeInForce` is `GTC` or if `pendingAboveType` is `LIMIT_MAKER`.
`pendingAboveTimeInForce` | ENUM | NO | Required if `pendingAboveType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
`pendingAboveStrategyId` | LONG | NO | Arbitrary numeric value identifying the pending above order within an order strategy.
`pendingAboveStrategyType` | INT | NO | Arbitrary numeric value identifying the pending above order strategy. Values smaller than `1000000` are reserved and cannot be used.
`pendingAbovePegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`pendingAbovePegOffsetType` | ENUM | NO |
`pendingAbovePegOffsetValue` | INT | NO | Maximum: 100.
`pendingBelowType` | ENUM | NO | Supported values: `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`
`pendingBelowClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent.
`pendingBelowPrice` | DECIMAL | NO | Can be used if `pendingBelowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` to specify the limit price.
`pendingBelowStopPrice` | DECIMAL | NO | Can be used if `pendingBelowType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `pendingBelowStopPrice` or `pendingBelowTrailingDelta` or both, must be specified.
`pendingBelowTrailingDelta` | DECIMAL | NO | See [Trailing Stop order FAQ](faqs/trailing-stop-faq.md)
`pendingBelowIcebergQty` | DECIMAL | NO | This can only be used if `pendingBelowTimeInForce` is `GTC`, or if `pendingBelowType` is `LIMIT_MAKER`.
`pendingBelowTimeInForce` | ENUM | NO | Required if `pendingBelowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
`pendingBelowStrategyId` | LONG | NO | Arbitrary numeric value identifying the pending below order within an order strategy.
`pendingBelowStrategyType` | INT | NO | Arbitrary numeric value identifying the pending below order strategy. Values smaller than `1000000` are reserved and cannot be used.
`pendingBelowPegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`pendingBelowPegOffsetType` | ENUM | NO |
`pendingBelowPegOffsetValue` | INT | NO | Maximum: 100.
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

<a id="mandatory-parameters-based-on-pendingabovetype-pendingbelowtype-or-workingtype"></a>

**Mandatory parameters based on `pendingAboveType`, `pendingBelowType` or `workingType`**

Depending on the `pendingAboveType`/`pendingBelowType` or `workingType`, some optional parameters will become mandatory.

|Type                                                       |Additional mandatory parameters|Additional information|
|----                                                       |----                           |------
|`workingType` = `LIMIT`                                    |`workingTimeInForce`           |
|`pendingAboveType`= `LIMIT_MAKER`                                |`pendingAbovePrice`          |
|`pendingAboveType` = `STOP_LOSS/TAKE_PROFIT`         |`pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`|
|`pendingAboveType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT`|`pendingAbovePrice`, `pendingAboveStopPrice` and/or `pendingAboveTrailingDelta`, `pendingAboveTimeInForce`|
|`pendingBelowType`= `LIMIT_MAKER`                                |`pendingBelowPrice`          |
`pendingBelowType= STOP_LOSS/TAKE_PROFIT`         |`pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`|
|`pendingBelowType=STOP_LOSS_LIMIT/TAKE_PROFIT_LIMIT`|`pendingBelowPrice`, `pendingBelowStopPrice` and/or `pendingBelowTrailingDelta`, `pendingBelowTimeInForce`|

**Response:**
```javascript
{
    "id": "1712544408508",
    "status": 200,
    "result": {
        "orderListId": 629,
        "contingencyType": "OTO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": "GaeJHjZPasPItFj4x7Mqm6",
        "transactionTime": 1712544408537,
        "symbol": "LTCBNB",
        "orders": [
            {
                "symbol": "LTCBNB",
                "orderId": 23,
                "clientOrderId": "OVQOpKwfmPCfaBTD0n7e7H"
            },
            {
                "symbol": "LTCBNB",
                "orderId": 24,
                "clientOrderId": "YcCPKCDMQIjNvLtNswt82X"
            },
            {
                "symbol": "LTCBNB",
                "orderId": 25,
                "clientOrderId": "ilpIoShcFZ1ZGgSASKxMPt"
            }
        ],
        "orderReports": [
            {
                "symbol": "LTCBNB",
                "orderId": 23,
                "orderListId": 629,
                "clientOrderId": "OVQOpKwfmPCfaBTD0n7e7H",
                "transactTime": 1712544408537,
                "price": "1.500000",
                "origQty": "1.000000",
                "executedQty": "0.000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.000000",
                "status": "NEW",
                "timeInForce": "GTC",
                "type": "LIMIT",
                "side": "BUY",
                "workingTime": 1712544408537,
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "LTCBNB",
                "orderId": 24,
                "orderListId": 629,
                "clientOrderId": "YcCPKCDMQIjNvLtNswt82X",
                "transactTime": 1712544408537,
                "price": "0.000000",
                "origQty": "5.000000",
                "executedQty": "0.000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.000000",
                "status": "PENDING_NEW",
                "timeInForce": "GTC",
                "type": "STOP_LOSS",
                "side": "SELL",
                "stopPrice": "0.500000",
                "workingTime": -1,
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "LTCBNB",
                "orderId": 25,
                "orderListId": 629,
                "clientOrderId": "ilpIoShcFZ1ZGgSASKxMPt",
                "transactTime": 1712544408537,
                "price": "5.000000",
                "origQty": "5.000000",
                "executedQty": "0.000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.000000",
                "status": "PENDING_NEW",
                "timeInForce": "GTC",
                "type": "LIMIT_MAKER",
                "side": "SELL",
                "workingTime": -1,
                "selfTradePreventionMode": "NONE"
            }
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "ORDERS",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 10000000,
            "count": 18
        },
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 1000,
            "count": 65
        }
    ]
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="orderList.place.opo"></a>
<a id="orderList-place-opo"></a>
<a id="order-list-place-opo"></a>
<a id="orderlist-place-opo"></a>

### OPO (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "orderList.place.opo",
    "params": {
        "symbol": "BTCUSDT",
        "workingType": "LIMIT",
        "workingSide": "BUY",
        "workingPrice": "101496",
        "workingQuantity": "0.0007",
        "workingTimeInForce": "GTC",
        "pendingType": "MARKET",
        "pendingSide": "SELL",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Place an [OPO](faqs/opo.md).

* OPOs add 2 orders to the EXCHANGE_MAX_NUM_ORDERS filter and MAX_NUM_ORDERS filter.

**Weight:**
1

**Unfilled Order Count:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`listClientOrderId` | STRING | NO | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`.
`newOrderRespType` | ENUM | NO | Format of the JSON response. Supported values: [Order Response Type](enums.md#orderresponsetype)
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](enums.md#stpmodes)
`workingType` | ENUM | YES | Supported values: `LIMIT`, `LIMIT_MAKER`
`workingSide` | ENUM | YES | Supported values: [Order Side](enums.md#side)
`workingClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the working order. Automatically generated if not sent.
`workingPrice` | DECIMAL | YES | Price for the working order.
`workingQuantity` | DECIMAL | YES | Sets the quantity for the working order.
`workingIcebergQty` | DECIMAL | NO | This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`.
`workingTimeInForce` | ENUM | NO | Supported values: [Time In Force](enums.md#timeinforce)
`workingStrategyId` | LONG | NO | Arbitrary numeric value identifying the working order within an order strategy.
`workingStrategyType` | INT | NO | Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used.
`workingPegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`workingPegOffsetType` | ENUM | NO |
`workingPegOffsetValue` | INT | NO | Maximum: 100.
`pendingType` | ENUM | YES | Supported values: [Order Types](enums.md#ordertypes). Note that `MARKET` orders using `quoteOrderQty` are not supported.
`pendingSide` | ENUM | YES | Supported values: [Order Side](enums.md#side)
`pendingClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the pending order. Automatically generated if not sent.
`pendingPrice` | DECIMAL | NO | Price for the pending order.
`pendingStopPrice` | DECIMAL | NO | Stop price for the pending order.
`pendingTrailingDelta` | DECIMAL | NO | Trailing delta for the pending order.
`pendingIcebergQty` | DECIMAL | NO | This can only be used if `pendingTimeInForce` is `GTC` or if `pendingType` is `LIMIT_MAKER`.
`pendingTimeInForce` | ENUM | NO | Supported values: [Time In Force](enums.md#timeinforce)
`pendingStrategyId` | LONG | NO | Arbitrary numeric value identifying the pending order within an order strategy.
`pendingStrategyType` | INT | NO | Arbitrary numeric value identifying the pending order strategy. Values smaller than `1000000` are reserved and cannot be used.
`pendingPegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`pendingPegOffsetType` | ENUM | NO |
`pendingPegOffsetValue` | INT | NO | Maximum: 100.
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

**Response:**
```javascript
{
    "id": "eabb220d-1c53-4f8a-8bca-a1cd3594b3ce",
    "status": 200,
    "result": {
        "orderListId": 2,
        "contingencyType": "OTO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": "OiOgqvRagBefpzdM5gjYX3",
        "transactionTime": 1762941318142,
        "symbol": "BTCUSDT",
        "orders": [
            {
                "symbol": "BTCUSDT",
                "orderId": 2,
                "clientOrderId": "pUzhKBbc0ZVdMScIRAqitH"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 3,
                "clientOrderId": "x7ISSjywZxFXOdzwsThNnd"
            }
        ],
        "orderReports": [
            {
                "symbol": "BTCUSDT",
                "orderId": 2,
                "orderListId": 2,
                "clientOrderId": "pUzhKBbc0ZVdMScIRAqitH",
                "transactTime": 1762941318142,
                "price": "101496.00000000",
                "origQty": "0.00070000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.00000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "NEW",
                "timeInForce": "GTC",
                "type": "LIMIT",
                "side": "BUY",
                "workingTime": 1762941318142,
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 3,
                "orderListId": 2,
                "clientOrderId": "x7ISSjywZxFXOdzwsThNnd",
                "transactTime": 1762941318142,
                "price": "0.00000000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.00000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "PENDING_NEW",
                "timeInForce": "GTC",
                "type": "MARKET",
                "side": "SELL",
                "workingTime": -1,
                "selfTradePreventionMode": "NONE"
            }
        ]
    }
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="orderList.place.opoco"></a>
<a id="orderList-place-opoco"></a>
<a id="order-list-place-opoco"></a>
<a id="orderlist-place-opoco"></a>

### OPOCO (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "orderList.place.opoco",
    "params": {
        "symbol": "BTCUSDT",
        "workingType": "LIMIT",
        "workingSide": "BUY",
        "workingPrice": "102496",
        "workingQuantity": "0.0017",
        "workingTimeInForce": "GTC",
        "pendingSide": "SELL",
        "pendingAboveType": "LIMIT_MAKER",
        "pendingAbovePrice": "104261",
        "pendingBelowType": "STOP_LOSS_LIMIT",
        "pendingBelowPrice": "101613",
        "pendingBelowStopPrice": "10100",
        "pendingBelowTimeInForce": "IOC",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Place an [OPOCO](faqs/opo.md).

**Weight:**
1

**Unfilled Order Count:**
3

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`listClientOrderId` | STRING | NO | Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId`, `pendingAboveClientOrderId`, and the `pendingBelowClientOrderId`.
`newOrderRespType` | ENUM | NO | Format of the JSON response. Supported values: [Order Response Type](enums.md#orderresponsetype)
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](enums.md#stpmodes)
`workingType` | ENUM | YES |
`workingSide` | ENUM | YES | Supported values: [Order Side](enums.md#side)
`workingClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the working order. Automatically generated if not sent.
`workingPrice` | DECIMAL | YES | Price for the working order.
`workingQuantity` | DECIMAL | YES | Sets the quantity for the working order.
`workingIcebergQty` | DECIMAL | NO | This can only be used if `workingTimeInForce` is `GTC`, or if `workingType` is `LIMIT_MAKER`.
`workingTimeInForce` | ENUM | NO | Supported values: [Time In Force](enums.md#timeinforce)
`workingStrategyId` | LONG | NO | Arbitrary numeric value identifying the working order within an order strategy.
`workingStrategyType` | INT | NO | Arbitrary numeric value identifying the working order strategy. Values smaller than `1000000` are reserved and cannot be used.
`workingPegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`workingPegOffsetType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`workingPegOffsetValue` | INT | NO | Maximum: 100. <br/> Price level for pegging (max: 100). See [Pegged Orders](faqs/pegged_orders.md)
`pendingSide` | ENUM | YES | Supported values: [Order Side](enums.md#side)
`pendingAboveType` | ENUM | YES | Supported values: `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`
`pendingAboveClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent.
`pendingAbovePrice` | DECIMAL | NO | Can be used if `pendingAboveType` is `STOP_LOSS_LIMIT`, `LIMIT_MAKER`, or `TAKE_PROFIT_LIMIT` to specify the limit price.
`pendingAboveStopPrice` | DECIMAL | NO | Can be used if `pendingAboveType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`.
`pendingAboveTrailingDelta` | DECIMAL | NO | See [Trailing Stop order FAQ](faqs/trailing-stop-faq.md)
`pendingAboveIcebergQty` | DECIMAL | NO | This can only be used if `pendingAboveTimeInForce` is `GTC` or `pendingAboveType` is `LIMIT_MAKER`.
`pendingAboveTimeInForce` | ENUM | NO | Required if `pendingAboveType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
`pendingAboveStrategyId` | LONG | NO | Arbitrary numeric value identifying the pending above order within an order strategy.
`pendingAboveStrategyType` | INT | NO | Arbitrary numeric value identifying the pending above order strategy. Values smaller than `1000000` are reserved and cannot be used.
`pendingAbovePegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`pendingAbovePegOffsetType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`pendingAbovePegOffsetValue` | INT | NO | Maximum: 100. <br/> Price level for pegging (max: 100). See [Pegged Orders](faqs/pegged_orders.md)
`pendingBelowType` | ENUM | NO | Supported values: `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`
`pendingBelowClientOrderId` | STRING | NO | Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent.
`pendingBelowPrice` | DECIMAL | NO | Can be used if `pendingBelowType` is `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` to specify the limit price.
`pendingBelowStopPrice` | DECIMAL | NO | Can be used if `pendingBelowType` is `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, `TAKE_PROFIT_LIMIT`. Either `pendingBelowStopPrice` or `pendingBelowTrailingDelta` or both, must be specified.
`pendingBelowTrailingDelta` | DECIMAL | NO | See [Trailing Stop order FAQ](faqs/trailing-stop-faq.md)
`pendingBelowIcebergQty` | DECIMAL | NO | This can only be used if `pendingBelowTimeInForce` is `GTC` or `pendingBelowType` is `LIMIT_MAKER`.
`pendingBelowTimeInForce` | ENUM | NO | Supported values: [Time In Force](enums.md#timeinforce)
`pendingBelowStrategyId` | LONG | NO | Arbitrary numeric value identifying the pending below order within an order strategy.
`pendingBelowStrategyType` | INT | NO | Arbitrary numeric value identifying the pending below order strategy. Values smaller than `1000000` are reserved and cannot be used.
`pendingBelowPegPriceType` | ENUM | NO | See [Pegged Orders](faqs/pegged_orders.md)
`pendingBelowPegOffsetType` | ENUM | NO |
`pendingBelowPegOffsetValue` | INT | NO | Maximum: 100.
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

**Response:**
```javascript
{
    "id": "606063bf-43ea-40a6-a463-5c66fbd53b56",
    "status": 200,
    "result": {
        "orderListId": 1,
        "contingencyType": "OTO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": "TVbG6ymkYMXTj7tczbOsBf",
        "transactionTime": 1763000139104,
        "symbol": "BTCUSDT",
        "orders": [
            {
                "symbol": "BTCUSDT",
                "orderId": 6,
                "clientOrderId": "3czuJSeyjPwV9Xo28j1Dv3"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 7,
                "clientOrderId": "kyIKnMLKQclE5FmyYgaMSo"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 8,
                "clientOrderId": "i76cGJWN9J1FpADS56TtQZ"
            }
        ],
        "orderReports": [
            {
                "symbol": "BTCUSDT",
                "orderId": 6,
                "orderListId": 1,
                "clientOrderId": "3czuJSeyjPwV9Xo28j1Dv3",
                "transactTime": 1763000139104,
                "price": "102496.00000000",
                "origQty": "0.00170000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.00000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "NEW",
                "timeInForce": "GTC",
                "type": "LIMIT",
                "side": "BUY",
                "workingTime": 1763000139104,
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 7,
                "orderListId": 1,
                "clientOrderId": "kyIKnMLKQclE5FmyYgaMSo",
                "transactTime": 1763000139104,
                "price": "101613.00000000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.00000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "PENDING_NEW",
                "timeInForce": "IOC",
                "type": "STOP_LOSS_LIMIT",
                "side": "SELL",
                "stopPrice": "10100.00000000",
                "workingTime": -1,
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 8,
                "orderListId": 1,
                "clientOrderId": "i76cGJWN9J1FpADS56TtQZ",
                "transactTime": 1763000139104,
                "price": "104261.00000000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.00000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "PENDING_NEW",
                "timeInForce": "GTC",
                "type": "LIMIT_MAKER",
                "side": "SELL",
                "workingTime": -1,
                "selfTradePreventionMode": "NONE"
            }
        ]
    }
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="orderList.cancel"></a>
<a id="orderList-cancel"></a>
<a id="order-list-cancel"></a>
<a id="orderlist-cancel"></a>

### Cancel Order list (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "orderList.cancel",
    "params": {
        "symbol": "BTCUSDT",
        "orderListId": 1274512,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Cancel an active order list.

**Weight:**
1

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`orderListId` | INT | NO | Either `orderListId` or `listClientOrderId` must be provided
`listClientOrderId` | STRING | NO | Either `orderListId` or `listClientOrderId` must be provided
`newClientOrderId` | STRING | NO | Used to uniquely identify this cancel. Automatically generated by default.
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

Notes:

* If both `orderListId` and `listClientOrderId` parameters are provided, the `orderListId` is searched first, then the `listClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected.

* Canceling an individual order with [`order.cancel`](#order-cancel) will cancel the entire order list as well.

**Response:**
```javascript
{
    "id": "c5899911-d3f4-47ae-8835-97da553d27d0",
    "status": 200,
    "result": {
        "orderListId": 1274512,
        "contingencyType": "OCO",
        "listStatusType": "ALL_DONE",
        "listOrderStatus": "ALL_DONE",
        "listClientOrderId": "6023531d7edaad348f5aff",
        "transactionTime": 1660801720215,
        "symbol": "BTCUSDT",
        "orders": [
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138901,
                "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138902,
                "clientOrderId": "jLnZpj5enfMXTuhKB1d0us"
            }
        ],
        "orderReports": [
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138901,
                "orderListId": 1274512,
                "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU",
                "transactTime": 1660801720215,
                "price": "23410.00000000",
                "origQty": "0.00650000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "CANCELED",
                "timeInForce": "GTC",
                "type": "STOP_LOSS_LIMIT",
                "side": "SELL",
                "stopPrice": "23405.00000000", // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
                "selfTradePreventionMode": "NONE"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138902,
                "orderListId": 1274512,
                "clientOrderId": "jLnZpj5enfMXTuhKB1d0us",
                "transactTime": 1660801720215,
                "price": "23420.00000000",
                "origQty": "0.00650000",
                "executedQty": "0.00000000",
                "origQuoteOrderQty": "0.000000",
                "cummulativeQuoteQty": "0.00000000",
                "status": "CANCELED",
                "timeInForce": "GTC",
                "type": "LIMIT_MAKER",
                "side": "SELL",
                "selfTradePreventionMode": "NONE"
            }
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

<a id="sor.order.place"></a>
<a id="sor-order-place"></a>
<a id="sor"></a>

### Place new order using SOR (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "sor.order.place",
    "params": {
        "symbol": "BTCUSDT",
        "side": "BUY",
        "type": "LIMIT",
        "timeInForce": "GTC",
        "price": 31000,
        "quantity": 0.5,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
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](faqs/sor_faq.md) to learn more.

**Weight:**
1

**Unfilled Order Count:**
1

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`side` | ENUM | YES | `BUY` or `SELL`
`type` | ENUM | YES | Only `LIMIT` and `MARKET` orders are supported.
`timeInForce` | ENUM | NO | Applicable only to `LIMIT` order type.
`price` | DECIMAL | NO |
`quantity` | DECIMAL | YES |
`newClientOrderId` | STRING | NO | A unique id among open orders. Automatically generated if not sent.<br/> Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected.
`newOrderRespType` | ENUM | NO | Set the response JSON. `ACK`, `RESULT`, or `FULL`. Default to `FULL`
`icebergQty` | DECIMAL | NO | Used with `LIMIT` to create an iceberg order.
`strategyId` | LONG | NO |
`strategyType` | INT | NO | The value cannot be less than `1000000`.
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol. The possible supported values are: [STP Modes](enums.md#stpmodes).
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Matching Engine

**Note:** `sor.order.place` only supports `LIMIT` and `MARKET` orders. `quoteOrderQty` is not supported.

**Response:**
```javascript
{
    "id": "3a4437e2-41a3-4c19-897c-9cadc5dce8b6",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "orderId": 2,
            "orderListId": -1,
            "clientOrderId": "sBI1KM6nNtOfj5tccZSKly",
            "transactTime": 1689149087774,
            "price": "31000.00000000",
            "origQty": "0.50000000",
            "executedQty": "0.50000000",
            "origQuoteOrderQty": "0.000000",
            "cummulativeQuoteQty": "14000.00000000",
            "status": "FILLED",
            "timeInForce": "GTC",
            "type": "LIMIT",
            "side": "BUY",
            "workingTime": 1689149087774,
            "fills": [
                {
                    "matchType": "ONE_PARTY_TRADE_REPORT",
                    "price": "28000.00000000",
                    "qty": "0.50000000",
                    "commission": "0.00000000",
                    "commissionAsset": "BTC",
                    "tradeId": -1,
                    "allocId": 0
                }
            ],
            "workingFloor": "SOR",                   // Determines whether the order is being filled by the SOR or by the order book.
            "selfTradePreventionMode": "NONE",
            "usedSor": true,                         // Field that determines whether order used SOR.
            "stopPrice": "0.00000000",               // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
            "trailingDelta": 10,                     // Delta price change required before order activation.
            "icebergQty": "0.00000000",              // Appears only if the parameter icebergQty was sent in the request.
            "strategyId": 1,                         // Appears only if the strategyId parameter was provided upon order placement.
            "strategyType": 1000000,                 // Appears only if the strategyType parameter was provided upon order placement.
            "preventedMatchId": 0,                   // Appears only if the order expired due to STP.
            "preventedQuantity": "1.200000",         // Order quantity that expired due to STP.
            "trailingTime": -1,                      // Time when the trailing order is now active and tracking price changes.
            "pegPriceType": "PRIMARY_PEG",           // Price peg type. Only for pegged orders.
            "pegOffsetType": "PRICE_LEVEL",          // Price peg offset type. Only for pegged orders, if requested.
            "pegOffsetValue": 5,                     // Price peg offset value. Only for pegged orders, if requested.
            "peggedPrice": "87523.83710000",         // Current price order is pegged at. Only for pegged orders, once determined.
            "expiryReason": "INSUFFICIENT_LIQUIDITY" // Cause of the order's expiration. Appears when an order has expired.
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

<a id="sor.order.test"></a>
<a id="sor-order-test"></a>

### Test new order using SOR (TRADE)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "sor.order.test",
    "params": {
        "symbol": "BTCUSDT",
        "side": "BUY",
        "type": "LIMIT",
        "timeInForce": "GTC",
        "price": 0.1,
        "quantity": 0.1,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
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 |

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`computeCommissionRates` | BOOLEAN | NO | Default: `false`
`symbol` | STRING | YES |
`side` | ENUM | YES | Please see [Enums](enums.md#side) for supported values.
`type` | ENUM | YES | Please see [Enums](enums.md#ordertypes) for supported values.
`timeInForce` | ENUM | NO | Please see [Enums](enums.md#timeinforce) for supported values.
`price` | DECIMAL | NO |
`quantity` | DECIMAL | YES |
`newClientOrderId` | STRING | NO | A unique id among open orders. Automatically generated if not sent. Orders with the same `newClientOrderID` can be accepted only when the previous one is filled, otherwise the order will be rejected.
`newOrderRespType` | ENUM | NO | Set the response JSON. `ACK`, `RESULT`, or `FULL`. Default to `FULL`.
`icebergQty` | DECIMAL | NO | Used with `LIMIT` to create an iceberg order.
`strategyId` | LONG | NO |
`strategyType` | INT | NO | The value cannot be less than `1000000`.
`selfTradePreventionMode` | ENUM | NO | The allowed enums is dependent on what is configured on the symbol. Supported values: [STP Modes](enums.md#stpmodes)
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory

**Response:**

Without `computeCommissionRates`:

```javascript
{
    "id": "3a4437e2-41a3-4c19-897c-9cadc5dce8b6",
    "status": 200,
    "result": {},
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 1
        }
    ]
}
```

With `computeCommissionRates`:

```javascript
{
    "id": "3a4437e2-41a3-4c19-897c-9cadc5dce8b6",
    "status": 200,
    "result": {
        // Standard commission rates on trades from the order.
        "standardCommissionForOrder": {
            "maker": "0.00000112",
            "taker": "0.00000114"
        },
        // Tax commission rates for trades from the order.
        "taxCommissionForOrder": {
            "maker": "0.00000112",
            "taker": "0.00000114"
        },
        // Discount on standard commissions when paying in BNB.
        "discount": {
            "enabledForAccount": true,
            "enabledForSymbol": true,
            "discountAsset": "BNB",
            "discount": "0.25000000" // Standard commission is reduced by this rate when paying commission in BNB.
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

## Account requests

<a id="account.status"></a>
<a id="account-status"></a>

### Account information (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "account.status",
    "params": {
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Query information about your account.

**Weight:**
20

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`omitZeroBalances` | BOOLEAN | NO | When set to `true`, emits only the non-zero balances of an account. Default value: `false`.
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory => Database

**Response:**
```javascript
{
    "id": "605a6d20-6588-4cb9-afa0-b0ab087507ba",
    "status": 200,
    "result": {
        "makerCommission": 15,
        "takerCommission": 15,
        "buyerCommission": 0,
        "sellerCommission": 0,
        "canTrade": true,
        "canWithdraw": true,
        "canDeposit": true,
        "commissionRates": {
            "maker": "0.00150000",
            "taker": "0.00150000",
            "buyer": "0.00000000",
            "seller": "0.00000000"
        },
        "brokered": false,
        "requireSelfTradePrevention": false,
        "preventSor": false,
        "updateTime": 1660801833000,
        "accountType": "SPOT",
        "balances": [
            {
                "asset": "BNB",
                "free": "0.00000000",
                "locked": "0.00000000"
            },
            {
                "asset": "BTC",
                "free": "1.3447112",
                "locked": "0.08600000"
            },
            {
                "asset": "USDT",
                "free": "1021.21000000",
                "locked": "0.00000000"
            }
        ],
        "permissions": [
            "SPOT"
        ],
        "uid": 354937868
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

<a id="order.status"></a>
<a id="order-status"></a>

### Query order (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "order.status",
    "params": {
        "symbol": "BTCUSDT",
        "orderId": 12569099453,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Check execution status of an order.

**Weight:**
4

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`orderId` | LONG | NO | Lookup order by `orderId`
`origClientOrderId` | STRING | NO | Lookup order by `clientOrderId`
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory => Database

Notes:

* If both `orderId` and `origClientOrderId` are provided, the `orderId` is searched first, then the `origClientOrderId` from that result is checked against that order. If both conditions are not met the request will be rejected.

* For some historical orders the `cummulativeQuoteQty` response field may be negative,
  meaning the data is not available at this time.

**Response:**
```javascript
{
    "id": "aa62318a-5a97-4f3b-bdc7-640bbe33b291",
    "status": 200,
    "result": {
        "symbol": "BTCUSDT",
        "orderId": 12569099453,
        "orderListId": -1,                       // Present only for orders that belong to an order list.
        "clientOrderId": "4d96324ff9d44481926157",
        "price": "23416.10000000",
        "origQty": "0.00847000",
        "executedQty": "0.00847000",
        "origQuoteOrderQty": "0.000000",         // Always present. Zero if the order type does not use `quoteOrderQty`.
        "cummulativeQuoteQty": "198.33521500",
        "status": "FILLED",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "SELL",
        "stopPrice": "0.00000000",               // Always present. Zero if the order type does not use `stopPrice`.
        "trailingDelta": 10,                     // Present only if `trailingDelta` was set on the order.
        "trailingTime": -1,                      // Present only if `trailingDelta` was set on the order.
        "icebergQty": "0.00000000",              // Always present. Zero for non-iceberg orders.
        "time": 1660801715639,                   // Order placement time.
        "updateTime": 1660801717945,             // Time of the last update to the order.
        "isWorking": true,
        "workingTime": 1660801715639,
        "strategyId": 37463720,                  // Present only if `strategyId` was set on the order.
        "strategyType": 1000000,                 // Present only if `strategyType` was set on the order.
        "selfTradePreventionMode": "NONE",
        "preventedMatchId": 0,                   // Present only if the order expired due to STP.
        "preventedQuantity": "1.200000",         // Present only if the order expired due to STP.
        "usedSor": true,                         // Field that determines whether order used SOR.
        "workingFloor": "SOR",                   // Determines whether the order is being filled by the SOR or by the order book.
        "pegPriceType": "PRIMARY_PEG",           // Price peg type. Only for pegged orders.
        "pegOffsetType": "PRICE_LEVEL",          // Price peg offset type. Only for pegged orders, if requested.
        "pegOffsetValue": 5,                     // Price peg offset value. Only for pegged orders, if requested.
        "peggedPrice": "87523.83710000",         // Current price order is pegged at. Only for pegged orders, once determined.
        "expiryReason": "INSUFFICIENT_LIQUIDITY" // Cause of the order's expiration. Appears when an order has expired.
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="openOrders.status"></a>
<a id="openOrders-status"></a>
<a id="open-orders-status"></a>
<a id="openorders-status"></a>

### Current open orders (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "openOrders.status",
    "params": {
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Query execution status of all open orders.

If you need to continuously monitor order status updates, please consider using WebSocket Streams:

* [`userDataStream.subscribe`](web-socket-api.md#subscribe-to-user-data-stream-user_stream) if on an authenticated session
* [`userDataStream.subscribe.signature`](web-socket-api.md#subscribe-to-user-data-stream-through-signature-subscription-user_stream) if subscribing through signature subscription

**Weight:**
| Parameter | Weight |
| --------- | ------ |
| `symbol`  |      6 |
| none      |     80 |

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | NO | If omitted, open orders for all symbols are returned
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory => Database

**Response:**
```javascript
{
    "id": "55f07876-4f6f-4c47-87dc-43e5fff3f2e7",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "orderId": 12569099453,
            "orderListId": -1,                       // Present only for orders that belong to an order list.
            "clientOrderId": "4d96324ff9d44481926157",
            "price": "23416.10000000",
            "origQty": "0.00847000",
            "executedQty": "0.00720000",
            "origQuoteOrderQty": "0.000000",         // Always present. Zero if the order type does not use `quoteOrderQty`.
            "cummulativeQuoteQty": "172.43931000",
            "status": "PARTIALLY_FILLED",
            "timeInForce": "GTC",
            "type": "LIMIT",
            "side": "SELL",
            "time": 1660801715639,                   // Order placement time.
            "updateTime": 1660801717945,             // Time of the last update to the order.
            "isWorking": true,
            "workingTime": 1660801715639,
            "selfTradePreventionMode": "NONE",
            "icebergQty": "0.00000000",              // Appears only if the parameter icebergQty was sent in the request.
            "preventedMatchId": 0,                   // Appears only if the order expired due to STP.
            "preventedQuantity": "1.200000",         // Order quantity that expired due to STP.
            "stopPrice": "0.00000000",               // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
            "strategyId": 1,                         // Appears only if the strategyId parameter was provided upon order placement.
            "strategyType": 1000000,                 // Appears only if the strategyType parameter was provided upon order placement.
            "trailingDelta": 10,                     // Delta price change required before order activation.
            "trailingTime": -1,                      // Time when the trailing order is now active and tracking price changes.
            "usedSor": true,                         // Field that determines whether order used SOR.
            "workingFloor": "SOR",                   // Determines whether the order is being filled by the SOR or by the order book.
            "pegPriceType": "PRIMARY_PEG",           // Price peg type. Only for pegged orders.
            "pegOffsetType": "PRICE_LEVEL",          // Price peg offset type. Only for pegged orders, if requested.
            "pegOffsetValue": 5,                     // Price peg offset value. Only for pegged orders, if requested.
            "peggedPrice": "87523.83710000",         // Current price order is pegged at. Only for pegged orders, once determined.
            "expiryReason": "INSUFFICIENT_LIQUIDITY" // Cause of the order's expiration. Appears when an order has expired.
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 6
        }
    ]
}
```

**Note:** The payload above does not show all fields that can appear. Please refer to [Conditional fields in Order Responses](web-socket-api.md#conditional-fields-in-order-responses).

<a id="allOrders"></a>
<a id="all-orders"></a>
<a id="allorders"></a>

### Account order history (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "allOrders",
    "params": {
        "symbol": "BNBUSDT",
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Query information about all your orders – active, canceled, filled – filtered by time range.

**Weight:**
20

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`orderId` | LONG | NO | Order ID to begin at
`startTime` | LONG | NO | Timestamp in ms
`endTime` | LONG | NO | Timestamp in ms
`limit` | INT | NO | Default: 500; Maximum: 1000
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Database

Notes:

* If `startTime` and/or `endTime` are specified, `orderId` is ignored.

  Orders are filtered by `time` of the last execution status update.

* If `orderId` is specified, return orders with order ID >= `orderId`.

* If no condition is specified, the most recent orders are returned.

* For some historical orders the `cummulativeQuoteQty` response field may be negative,
  meaning the data is not available at this time.

* The time between `startTime` and `endTime` can't be longer than 24 hours.

**Response:**
```javascript
{
    "id": "734235c2-13d2-4574-be68-723e818c08f3",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "orderId": 12569099453,
            "orderListId": -1,                       // Present only for orders that belong to an order list.
            "clientOrderId": "4d96324ff9d44481926157",
            "price": "23416.10000000",
            "origQty": "0.00847000",
            "executedQty": "0.00847000",
            "cummulativeQuoteQty": "198.33521500",
            "status": "FILLED",
            "timeInForce": "GTC",
            "type": "LIMIT",
            "side": "SELL",
            "time": 1660801715639,                   // Order placement time.
            "updateTime": 1660801717945,             // Time of the last update to the order.
            "isWorking": true,
            "workingTime": 1660801715639,
            "origQuoteOrderQty": "0.000000",         // Always present. Zero if the order type does not use `quoteOrderQty`.
            "selfTradePreventionMode": "NONE",
            "preventedMatchId": 0,                   // Present only if the order expired due to STP.
            "preventedQuantity": "1.200000",         // Present only if the order expired due to STP.
            "icebergQty": "0.00000000",              // Appears only if the parameter icebergQty was sent in the request.
            "stopPrice": "0.00000000",               // Appears for STOP_LOSS, TAKE_PROFIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT orders.
            "strategyId": 1,                         // Appears only if the strategyId parameter was provided upon order placement.
            "strategyType": 1000000,                 // Appears only if the strategyType parameter was provided upon order placement.
            "trailingDelta": 10,                     // Delta price change required before order activation.
            "trailingTime": -1,                      // Time when the trailing order is now active and tracking price changes.
            "usedSor": true,                         // Field that determines whether order used SOR.
            "workingFloor": "SOR",                   // Determines whether the order is being filled by the SOR or by the order book.
            "pegPriceType": "PRIMARY_PEG",           // Price peg type. Only for pegged orders.
            "pegOffsetType": "PRICE_LEVEL",          // Price peg offset type. Only for pegged orders, if requested.
            "pegOffsetValue": 5,                     // Price peg offset value. Only for pegged orders, if requested.
            "peggedPrice": "87523.83710000",         // Current price order is pegged at. Only for pegged orders, once determined.
            "expiryReason": "INSUFFICIENT_LIQUIDITY" // Cause of the order's expiration. Appears when an order has expired.
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

<a id="orderList.status"></a>
<a id="orderList-status"></a>
<a id="order-list-status"></a>
<a id="orderlist-status"></a>

### Query Order list (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "orderList.status",
    "params": {
        "origClientOrderId": "08985fedd9ea2cf6b28996",
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Check execution status of an Order list.

For execution status of individual orders, use `order.status`.

**Weight:**
4

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`origClientOrderId` | STRING | NO | Query order list by `listClientOrderId`. `orderListId` or `origClientOrderId` must be provided.
`orderListId` | INT | NO | Query order list by `orderListId`. `orderListId` or `origClientOrderId` must be provided.
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Database

Notes:

* `origClientOrderId` refers to `listClientOrderId` of the order list itself.

* If both `origClientOrderId` and `orderListId` parameters are specified,
  only `origClientOrderId` is used and `orderListId` is ignored.

**Response:**
```javascript
{
    "id": "b53fd5ff-82c7-4a04-bd64-5f9dc42c2100",
    "status": 200,
    "result": {
        "orderListId": 1274512,
        "contingencyType": "OCO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": "08985fedd9ea2cf6b28996",
        "transactionTime": 1660801713793,
        "symbol": "BTCUSDT",
        "orders": [
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138901,
                "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU"
            },
            {
                "symbol": "BTCUSDT",
                "orderId": 12569138902,
                "clientOrderId": "jLnZpj5enfMXTuhKB1d0us"
            }
        ]
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

<a id="openOrderLists.status"></a>
<a id="openOrderLists-status"></a>
<a id="open-order-lists-status"></a>
<a id="openorderlists-status"></a>

### Current open Order lists (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "openOrderLists.status",
    "params": {
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Query execution status of all open order lists.

If you need to continuously monitor order status updates, please consider using WebSocket Streams:

* [`userDataStream.subscribe`](web-socket-api.md#subscribe-to-user-data-stream-user_stream) if on an authenticated session
* [`userDataStream.subscribe.signature`](web-socket-api.md#subscribe-to-user-data-stream-through-signature-subscription-user_stream) if subscribing through signature subscription

**Weight:**
6

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory -> Database

**Response:**
```javascript
{
    "id": "3a4437e2-41a3-4c19-897c-9cadc5dce8b6",
    "status": 200,
    "result": [
        {
            "orderListId": 0,
            "contingencyType": "OCO",
            "listStatusType": "EXEC_STARTED",
            "listOrderStatus": "EXECUTING",
            "listClientOrderId": "08985fedd9ea2cf6b28996",
            "transactionTime": 1660801713793,
            "symbol": "BTCUSDT",
            "orders": [
                {
                    "symbol": "BTCUSDT",
                    "orderId": 4,
                    "clientOrderId": "CUhLgTXnX5n2c0gWiLpV4d"
                },
                {
                    "symbol": "BTCUSDT",
                    "orderId": 5,
                    "clientOrderId": "1ZqG7bBuYwaF4SU8CwnwHm"
                }
            ]
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 6
        }
    ]
}
```

<a id="allOrderLists"></a>
<a id="all-order-lists"></a>
<a id="allorderlists"></a>

### Account order list history (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "allOrderLists",
    "params": {
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Query information about all your order lists, filtered by time range.

**Weight:**
20

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`fromId` | INT | NO | Order list ID to begin at
`startTime` | LONG | NO | Timestamp in ms
`endTime` | LONG | NO | Timestamp in ms
`limit` | INT | NO | Default: 500; Maximum: 1000
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Database

Notes:
* If `startTime` and/or `endTime` are specified, `fromId` is ignored.
  Order lists are filtered by `transactionTime` of the last order list execution status update.
* If `fromId` is specified, return order lists with order list ID >= `fromId`.
* If no condition is specified, the most recent order lists are returned.
* The time between `startTime` and `endTime` can't be longer than 24 hours.

**Response:**
```javascript
{
    "id": "8617b7b3-1b3d-4dec-94cd-eefd929b8ceb",
    "status": 200,
    "result": [
        {
            "orderListId": 1274512,
            "contingencyType": "OCO",
            "listStatusType": "EXEC_STARTED",
            "listOrderStatus": "EXECUTING",
            "listClientOrderId": "08985fedd9ea2cf6b28996",
            "transactionTime": 1660801713793,
            "symbol": "BTCUSDT",
            "orders": [
                {
                    "symbol": "BTCUSDT",
                    "orderId": 12569138901,
                    "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU"
                },
                {
                    "symbol": "BTCUSDT",
                    "orderId": 12569138902,
                    "clientOrderId": "jLnZpj5enfMXTuhKB1d0us"
                }
            ]
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

<a id="myTrades"></a>
<a id="my-trades"></a>
<a id="mytrades"></a>

### Account trade history (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "myTrades",
    "params": {
        "symbol": "BNBUSDT",
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Query information about all your trades, filtered by time range.

**Weight:**
Condition| Weight|
---| ---
|Without orderId|20|
|With orderId|5|

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`orderId` | LONG | NO | This can only be used in combination with `symbol`.
`startTime` | LONG | NO | Timestamp in ms
`endTime` | LONG | NO | Timestamp in ms
`fromId` | INT | NO | First trade ID to query
`limit` | INT | NO | Default: 500; Maximum: 1000
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory => Database

Notes:
- If `fromId` is specified, return trades with trade ID >= `fromId`.
- If `startTime` and/or `endTime` are specified, trades are filtered by execution time (`time`).
- `fromId` cannot be used together with `startTime` and `endTime`.
- If `orderId` is specified, only trades related to that order are returned.
- `startTime` and `endTime` cannot be used together with `orderId`.
- If no condition is specified, the most recent trades are returned.
- The time between `startTime` and `endTime` can't be longer than 24 hours.

**Response:**
```javascript
{
    "id": "f4ce6a53-a29d-4f70-823b-4ab59391d6e8",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "id": 1650422481,
            "orderId": 12569099453,
            "orderListId": -1,
            "price": "23416.10000000",
            "qty": "0.00635000",
            "quoteQty": "148.69223500",
            "commission": "0.00000000",
            "commissionAsset": "BNB",
            "time": 1660801715793,
            "isBuyer": false,
            "isMaker": true,
            "isBestMatch": true
        },
        {
            "symbol": "BTCUSDT",
            "id": 1650422482,
            "orderId": 12569099453,
            "orderListId": -1,
            "price": "23416.50000000",
            "qty": "0.00212000",
            "quoteQty": "49.64298000",
            "commission": "0.00000000",
            "commissionAsset": "BNB",
            "time": 1660801715793,
            "isBuyer": false,
            "isMaker": true,
            "isBestMatch": true
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

<a id="account.rateLimits.orders"></a>
<a id="account-rateLimits-orders"></a>
<a id="account-rate-limits-orders"></a>
<a id="account-ratelimits-orders"></a>
<a id="query-unfilled-order-count"></a>

### Unfilled Order Count (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "account.rateLimits.orders",
    "params": {
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Query your current unfilled order count for all intervals.

**Weight:**
40

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "d3783d8d-f8d1-4d2c-b8a0-b7596af5a664",
    "status": 200,
    "result": [
        {
            "rateLimitType": "ORDERS",
            "interval": "SECOND",
            "intervalNum": 10,
            "limit": 50,
            "count": 0
        },
        {
            "rateLimitType": "ORDERS",
            "interval": "DAY",
            "intervalNum": 1,
            "limit": 160000,
            "count": 0
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 40
        }
    ]
}
```

<a id="myPreventedMatches"></a>
<a id="my-prevented-matches"></a>
<a id="mypreventedmatches"></a>

### Account prevented matches (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "myPreventedMatches",
    "params": {
        "symbol": "BTCUSDT",
        "orderId": 35,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
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

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`preventedMatchId` | LONG | NO | Prevented match ID
`orderId` | LONG | NO | Order ID
`fromPreventedMatchId` | LONG | NO | Prevented match ID to begin at
`limit` | INT | NO | Default: 500; Maximum: 1000
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Database

**Response:**
```javascript
{
    "id": "g4ce6a53-a39d-4f71-823b-4ab5r391d6y8",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "preventedMatchId": 1,
            "takerOrderId": 5,
            "makerSymbol": "BTCUSDT",
            "makerOrderId": 3,
            "tradeGroupId": 1,
            "selfTradePreventionMode": "EXPIRE_MAKER",
            "price": "1.100000",
            "makerPreventedQuantity": "1.300000",
            "transactTime": 1669101687094
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

<a id="myAllocations"></a>
<a id="my-allocations"></a>
<a id="myallocations"></a>

### Account allocations (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "myAllocations",
    "params": {
        "symbol": "BTCUSDT",
        "orderId": 500,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88",
        "timestamp": 1660801715431
    }
}
```
Retrieves allocations resulting from SOR order placement.

**Weight:**
20

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`startTime` | LONG | NO | Timestamp in ms
`endTime` | LONG | NO | Timestamp in ms
`fromAllocationId` | INT | NO | Allocation ID to begin at
`limit` | INT | NO | Default: 500; Maximum: 1000
`orderId` | LONG | NO | Order ID
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | NO | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Database

Supported parameter combinations:

Parameters                                  | Response |
------------------------------------------- | -------- |
`symbol`                                    | allocations from oldest to newest |
`symbol` + `startTime`                      | oldest allocations since `startTime` |
`symbol` + `endTime`                        | newest allocations until `endTime` |
`symbol` + `startTime` + `endTime`          | allocations within the time range |
`symbol` + `fromAllocationId`               | allocations by allocation ID |
`symbol` + `orderId`                        | allocations related to an order starting with oldest |
`symbol` + `orderId` + `fromAllocationId`   | allocations related to an order by allocation ID |

**Note:** The time between `startTime` and `endTime` can't be longer than 24 hours.

**Response:**
```javascript
{
    "id": "g4ce6a53-a39d-4f71-823b-4ab5r391d6y8",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "allocationId": 0,
            "allocationType": "SOR",
            "orderId": 500,
            "orderListId": -1,
            "price": "1.00000000",
            "qty": "0.10000000",
            "quoteQty": "0.10000000",
            "commission": "0.00000000",
            "commissionAsset": "BTC",
            "time": 1687319487614,
            "isBuyer": false,
            "isMaker": false,
            "isAllocator": false
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

<a id="account.commission"></a>
<a id="account-commission"></a>

### Account Commission Rates (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "account.commission",
    "params": {
        "symbol": "BNBUSDT",
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Get current account commission rates.

**Weight:**
20

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Database

**Response:**
```javascript
{
    "id": "d3df8a61-98ea-4fe0-8f4e-0fcea5d418b0",
    "status": 200,
    "result": {
        "symbol": "BTCUSDT",
        // Standard commission rates on trades from the order.
        "standardCommission": {
            "maker": "0.00000010",
            "taker": "0.00000020",
            "buyer": "0.00000030",
            "seller": "0.00000040"
        },
        // Special commission rates from the order.
        "specialCommission": {
            "maker": "0.01000000",
            "taker": "0.02000000",
            "buyer": "0.03000000",
            "seller": "0.04000000"
        },
        // Tax commission rates on trades from the order.
        "taxCommission": {
            "maker": "0.00000112",
            "taker": "0.00000114",
            "buyer": "0.00000118",
            "seller": "0.00000116"
        },
        // Discount on standard commissions when paying in BNB.
        "discount": {
            "enabledForAccount": true,
            "enabledForSymbol": true,
            "discountAsset": "BNB",
            "discount": "0.75000000" // Multiplier applied to the standard commission when paying commission in BNB (e.g. 0.75 = 75% of the standard commission is charged).
        }
    },
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 20
        }
    ]
}
```

<a id="order.amendments"></a>
<a id="order-amendments"></a>

### Query Order Amendments (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "order.amendments",
    "params": {
        "symbol": "BNBUSDT",
        "orderId": 1,
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Queries all amendments of a single order.

**Weight:**
4

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`orderId` | LONG | YES | Order ID
`fromExecutionId` | LONG | NO | Execution ID to begin at
`limit` | LONG | NO | Default: 500; Maximum: 1000
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Database

**Response:**
```javascript
{
    "id": "6f5ebe91-01d9-43ac-be99-57cf062e0e30",
    "status": 200,
    "result": [
        {
            "symbol": "BTCUSDT",
            "orderId": 23,
            "executionId": 60,
            "origClientOrderId": "my_pending_order",
            "newClientOrderId": "xbxXh5SSwaHS7oUEOCI88B",
            "origQty": "7.00000000",
            "newQty": "5.00000000",
            "time": 1741924229819
        }
    ],
    "rateLimits": [
        {
            "rateLimitType": "REQUEST_WEIGHT",
            "interval": "MINUTE",
            "intervalNum": 1,
            "limit": 6000,
            "count": 4
        }
    ]
}
```

<a id="myFilters"></a>
<a id="my-filters"></a>
<a id="myfilters"></a>

### Query Relevant Filters (USER_DATA)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "myFilters",
    "params": {
        "symbol": "BNBUSDT",
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```
Retrieves the list of [filters](filters.md) relevant to an account on a given symbol. This is the only method
that shows if an account has [`MAX_ASSET`](filters.md#max_asset) filters applied to it.

**Weight:**
40

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`symbol` | STRING | YES |
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "1758009606869",
    "status": 200,
    "result": {
        "exchangeFilters": [
            {
                "filterType": "EXCHANGE_MAX_NUM_ORDERS",
                "maxNumOrders": 1000
            }
        ],
        "symbolFilters": [
            {
                "filterType": "PRICE_FILTER",
                "minPrice": "0.00000100",
                "maxPrice": "100000.00000000",
                "tickSize": "0.00000100"
            }
        ],
        "assetFilters": [
            {
                "filterType": "MAX_ASSET",
                "limit": "1000000.00000000",
                "asset": "JPY"
            }
        ],
        "rateLimits": [
            {
                "rateLimitType": "REQUEST_WEIGHT",
                "interval": "MINUTE",
                "intervalNum": 1,
                "limit": 6000,
                "count": 40
            }
        ]
    }
}
```

## User Data Stream requests

### User Data Stream subscription

<a id=general_info_user_data_stream_subscriptions></a>
**General information:**

* [User Data Stream](user-data-stream.md) subscriptions allow you to receive all the events related to a given account on a WebSocket connection.
* There are 2 ways to start a subscription:
  * If you have an authenticated session, then you can subscribe to events for that authenticated account using [`userDataStream.subscribe`](#user-data-stream-subscribe).
  * In any session, authenticated or not, you can subscribe to events for one or more accounts for which you can provide an API Key signature, using [`userDataStream.subscribe.signature`](#user-data-stream-subscribe-signature).
  * You can have only one active subscription for a given account on a given connection.
* Subscriptions are identified by a `subscriptionId` which is returned when starting the subscription. That `subscriptionId` allows you to map the events you receive to a given subscription.
  * All active subscriptions for a session can be found using [`session.subscriptions`](#session-subscriptions).
* Limits
  * A single session supports **up to 1,000 active subscriptions** simultaneously.
    * Attempting to start a new subscription beyond this limit will result in an error.
    * If your accounts are very active, we suggest not opening too many subscriptions at once, in order to not overload your connection.
  * A single session can handle a maximum of **65,535 total subscriptions** over its lifetime.
    * If this limit is reached, you will receive an error and must re-establish a new connection to be able to start new subscriptions.
* To verify the status of User Data Stream subscriptions, check the `userDataStream` field in [`session.status`](#query-session-status):
  * `null` - User Data Stream subscriptions are **not available** on this WebSocket API.
  * `true` - There is at **least one subscription active** in this session.
  * `false` - There are **no active subscriptions** in this session.

<a id="userDataStream.subscribe"></a>
<a id="userDataStream-subscribe"></a>
<a id="user-data-stream-subscribe"></a>
<a id="userdatastream-subscribe"></a>

### Subscribe to User Data Stream (USER_STREAM)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "userDataStream.subscribe",
    "params": {
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A"
    }
}
```
Subscribe to the User Data Stream in the current WebSocket connection.

**Notes:**
  - This method requires an authenticated WebSocket connection using Ed25519 keys. Please refer to [`session.logon`](web-socket-api.md#log-in-with-api-key-user_data).
  - To check the subscription status, use [`session.status`](web-socket-api.md#query-session-status), see the `userDataStream` flag indicating you have an active subscription.
  - User Data Stream events are available in both JSON and [SBE](faqs/sbe_faq.md) sessions.
    - Please refer to [User Data Streams](user-data-stream.md) for the event format details.
    - For SBE, only SBE schema 2:1 or later is supported.

**Weight:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |

**Response:**
```javascript
{
    "id": "d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7",
    "status": 200,
    "result": {
        "subscriptionId": 0
    }
}
```

<a id="userDataStream.unsubscribe"></a>
<a id="userDataStream-unsubscribe"></a>
<a id="user-data-stream-unsubscribe"></a>
<a id="userdatastream-unsubscribe"></a>

### Unsubscribe from User Data Stream

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "userDataStream.unsubscribe"
}
```
Stop listening to the User Data Stream in the current WebSocket
connection.

Note that `session.logout` will only close the subscription created with `userDataStream.subscribe` but not subscriptions opened with `userDataStream.subscribe.signature`.

**Weight:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`subscriptionId` | INT | NO | When called with no parameter, this will close all subscriptions. When called with the subscriptionId parameter, this will attempt to close the subscription with that subscription id, if it exists.

**Response:**
```javascript
{
    "id": "d3df8a21-98ea-4fe0-8f4e-0fcea5d418b7",
    "status": 200,
    "result": {}
}
```

<a id="session.subscriptions"></a>
<a id="session-subscriptions"></a>
<a id="session-subscription"></a>

### Listing all subscriptions

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "session.subscriptions"
}
```
**Note:**

* Users should track the corresponding subscription status of related accounts as needed.

**Weight:**
2

**Parameters:**
NONE

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "d3df5a22-88ea-4fe0-9f4e-0fcea5d418b7",
    "status": 200,
    "result": [
        {
            "subscriptionId": 0
        },
        {
            "subscriptionId": 1
        }
    ]
}
```

<a id="userDataStream.subscribe.signature"></a>
<a id="userDataStream-subscribe-signature"></a>
<a id="user-data-stream-subscribe-signature"></a>
<a id="userdatastream-subscribe-signature"></a>
<a id="user-data-signature"></a>

### Subscribe to User Data Stream through signature subscription (USER_STREAM)

```javascript
{
    "id": "5494febb-d167-46a2-996d-70533eb4d976",
    "method": "userDataStream.subscribe.signature",
    "params": {
        "timestamp": 1770736694138,
        "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A",
        "signature": "15af09e41c36f3cc61378c2fbe2c33719a03dd5eba8d0f9206fbda44de717c88"
    }
}
```

**Weight:**
2

**Parameters:**

Name | Type | Mandatory | Description
------------ | ------------ | ------------ | ------------
`apiKey` | STRING | YES |
`recvWindow` | DECIMAL | NO | Maximum: 60000. <br/> Supports up to three decimal places of precision (e.g., 6000.346) so that microseconds may be specified.
`timestamp` | LONG | YES | Unix timestamp used to sign the request, in milliseconds or microseconds. The value must reflect the current client <br/> time and is validated by the server for signed endpoints.
`signature` | STRING | YES |

**Data Source:** Memory

**Response:**
```javascript
{
    "id": "d3df8a22-98ea-4fe0-9f4e-0fcea5d418b7",
    "status": 200,
    "result": {
        "subscriptionId": 0
    }
}
```