Skip to content

Latest commit

 

History

History
1706 lines (1307 loc) · 75.7 KB

CHANGELOG.md

File metadata and controls

1706 lines (1307 loc) · 75.7 KB
Raw

CHANGELOG for Binance's API

Last Updated: 2024-12-17

2024-12-17

General Changes:

The system now supports microseconds in all related time and/or timestamp fields. Microsecond support is opt-in, by default the requests and responses still use milliseconds. Examples in documentation are also using milliseconds for the foreseeable future.

WebSocket Streams

  • A new optional parameter timeUnit can be used in the connection URL to select the time unit.
    • For example: /stream?streams=btcusdt@trade&timeUnit=millisecond
    • Supported values are:
      • MILLISECOND
      • millisecond
      • MICROSECOND
      • microsecond
    • If the time unit is not selected, milliseconds will be used by default.

REST API

  • A new optional header X-MBX-TIME-UNIT can be sent in the request to select the time unit.
    • Supported values:
      • MILLISECOND
      • millisecond
      • MICROSECOND
      • microsecond
    • The time unit affects timestamp fields in JSON responses (e.g., time, transactTime).
      • SBE responses continue to be in microseconds regardless of time unit.
    • If the time unit is not selected, milliseconds will be used by default.
  • Timestamp parameters (e.g. startTime, endTime, timestamp) can now be passed in milliseconds or microseconds.

WebSocket API

  • A new optional parameter timeUnit can be used in the connection URL to select the time unit.
    • Supported values:
      • MILLISECOND
      • millisecond
      • MICROSECOND
      • microsecond
    • The time unit affects timestamp fields in JSON responses (e.g., time, transactTime).
      • SBE responses continue to be in microseconds regardless of time unit.
    • If the time unit is not selected, milliseconds will be used by default.
  • Timestamp parameters (e.g. startTime, endTime, timestamp) can now be passed in milliseconds or microseconds.

User Data Streams

  • A new optional parameter timeUnit can be used in the connection URL to select the time unit.
    • Supported values
      • MILLISECOND
      • MICROSECOND.
      • microsecond
      • millisecond

2024-12-09

Notice: The changes below will be rolled out starting at 2024-12-12 and may take approximately a week to complete.

General Changes

  • Timestamp parameters now reject values too far into the past or the future. To be specific, the parameter will be rejected if:
    • timestamp before 2017-01-01 (less than 1483228800000)
    • timestamp is more than 10 seconds after the current time (e.g., if current time is 1729745280000 then it is an error to use 1729745291000 or greater)
  • If startTime and/or endTime values are outside of range, the values will be adjusted to fit the correct range.
  • The field for quote order quantity (origQuoteOrderQty) has been added to responses that previously did not have it. Note that for order placement endpoints the field will only appear for requests with newOrderRespType set to RESULT or FULL.
    • Please refer to the table below for affected requests with: origQuoteOrderQty:
Service Request
REST POST /api/v3/order
POST /api/v3/sor/order
POST /api/v3/order/oco
POST /api/v3/orderList/oco
POST /api/v3/orderList/oto
POST /api/v3/orderList/otoco
DELETE /api/v3/order
DELETE /api/v3/orderList
POST /api/v3/order/cancelReplace
WebSocket API order.place
sor.order.place
orderList.place
orderList.place.oco
orderList.place.oto
orderList.place.otoco
order.cancel
orderList.cancel
order.cancelReplace

SBE

  • A new schema 2:1 spot_2_1.xml has been released. The current schema 2:0 spot_2_0.xml will thus be deprecated, and retired from the API in 6 months as per our schema deprecation policy.
  • Schema 2:1 is a backward compatible update of schema 2:0. You will always receive payloads in 2:1 format when you request either schema 2:0 or 2:1.
  • Changes in SBE schema 2:1:
    • New field origQuoteOrderQty in order placement/cancellation responses (Note: Decoders generated using the 2:0 schema will skip this field.):
      • NewOrderResultResponse
      • NewOrderFullResponse
      • CancelOrderResponse
      • NewOrderListResultResponse
      • NewOrderListFullResponse
      • CancelOrderListResponse
    • WebSocket API only: New field userDataStream in session status responses:
      • WebSocketSessionLogonResponse
      • WebSocketSessionStatusResponse
      • WebSocketSessionLogoutResponse
    • WebSocket API only: New messages for User Data Stream support:
      • UserDataStreamSubscribeResponse
      • UserDataStreamUnsubscribeResponse
      • BalanceUpdateEvent
      • EventStreamTerminatedEvent
      • ExecutionReportEvent
      • ExternalLockUpdateEvent
      • ListStatusEvent
      • OutboundAccountPositionEvent

WebSocket API

  • You can now subscribe to User Data Stream events through your WebSocket API connection.
    • Note: This feature is only available for users of the Ed25519 API keys.
    • Note: New SBE schema 2:1 is required for User Data Stream subscriptions in SBE format.
  • New requests:
    • userDataStream.subscribe
    • userDataStream.unsubscribe
  • Changes to session.logon, session.status, and session.logout
    • Added a new field userDataStream indicating if the user data stream subscription is active.
  • Fixed a bug where you wouldn't receive a new listenKey using userDataStream.start after session.logon

User Data Stream

  • WebSocket API only: New event eventStreamTerminated is emitted when you either logout from your websocket session or you have unsubscribed from the user data stream.
  • New event externalLockUpdate is sent when your spot wallet balance is locked/unlocked by an external system.

FIX API

  • The schema has been updated with a new Administrative message News <B>, which can be used for all FIX services. Receiving this message indicates that your connection is about to be closed.

The following changes will occur between 2024-12-16 to 2024-12-20:

  • Fixed a bug that prevented orders from being placed when submitting OCOs on the BUY side without providing a stopPrice.
  • TAKE_PROFIT and TAKE_PROFIT_LIMIT support has been added for OCOs.
    • Previously OCOs could only be composed by the following order types:
      • LIMIT_MAKER + STOP_LOSS
      • LIMIT_MAKER + STOP_LOSS_LIMIT
    • Now OCOs can be composed of the following order types:
      • LIMIT_MAKER + STOP_LOSS
      • LIMIT_MAKER + STOP_LOSS_LIMIT
      • TAKE_PROFIT + STOP_LOSS
      • TAKE_PROFIT + STOP_LOSS_LIMIT
      • TAKE_PROFIT_LIMIT + STOP_LOSS
      • TAKE_PROFIT_LIMIT + STOP_LOSS_LIMIT
    • This is supported by the following requests:
      • POST /api/v3/orderList/oco
      • POST /api/v3/orderList/otoco
      • orderList.place.oco
      • orderList.place.otoco
      • NewOrderList<E>
    • Error code -1167 will be obsolete after this update and will be removed from the documentation in a later update.

2024-10-18

REST and WebSocket API:

2024-10-17

Changes to Exchange Information (i.e. GET /api/v3/exchangeInfo from REST and exchangeInfo for WebSocket API).

  • A new optional parameter showPermissionSets can be used to hide the permissions from permissionsSets; This can be used for a reduced payload size.
  • A new optional parameter symbolStatus can now be used to only show symbols with the specified status. (e.g. TRADING, HALT, BREAK)

2024-08-26

2024-08-16

Notice: The changes below are being rolled out gradually, and may take approximately a week to complete.

General Changes:

  • New error messages have been added when quote quantity market orders (aka reverse market orders) are rejected in low-liquidity situations.

2024-08-01

2024-07-26

2024-07-22

General changes:

  • Fixed a bug where klines had incorrect timestamps.
    • REST API: GET /api/v3/klines and GET /api/v3/uiKlines with timeZone parameter
    • WebSocket API: klines and uiKlines with timeZone parameter
    • WebSocket Streams: <symbol>@kline_<interval>@+08:00 streams

2024-06-11

  • On June 11, 05:00 UTC, One-Triggers-the-Other (OTO) orders and One-Triggers-a-One-Cancels-The-Other (OTOCO) orders will be enabled. (Note this may take a few hours to be rolled out to all servers.)
    • New requests have been added:
      • REST API:
        • POST /api/v3/orderList/oto
        • POST /api/v3/orderList/otoco
      • WebSocket API:
        • orderList.place.oto
        • orderList.place.otoco
  • On June 18, 05:00 UTC, Buyer order ID b and Seller order ID a will be removed from the Trade Streams (i.e. <symbol>@trade). (Note that this may take a few hours to be rolled out to all servers.)

2024-06-06

This will be available by June 6, 11:59 UTC.

REST API

  • orderRateLimitExceededMode has been added to POST /api/v3/order/cancelReplace.

WebSocket API

  • orderRateLimitExceededMode has been added to order.cancelReplace.

2024-05-30

WebSocket Streams:

  • Kline/Candlestick streams can now support a UTC+8 timezone offset. (e.g. btcusdt@kline_1d@+08:00)

2024-04-10

The following changes have been postponed to take effect on April 25, 05:00 UTC

General changes:

  • Symbol permission information in Exchange Information responses has moved from field permissions to field permissionSets.
  • Field permissions will be empty and will be removed in a future release.
  • Previously, "permissions":["SPOT","MARGIN"] meant that you could place an order on the symbol if your account had SPOT or MARGIN permissions. The equivalent is "permissionSets":[["SPOT","MARGIN"]]. (Note the extra set of square brackets.) Each array of permissions inside the permissionSets array is called a "permission set".
  • Symbol permissions can now be more complex. "permissionSets":[["SPOT","MARGIN"],["TRD_GRP_004","TRD_GRP_005"]] means that you may place an order on the symbol if your account has SPOT or MARGIN permissions and TRD_GRP_004 or TRD_GRP_005 permissions. There may be an arbitrary number of permission sets in a symbol's permissionSets.

REST API

  • otoAllowed will now appear on GET /api/v3/exchangeInfo, that indicates if One-Triggers-the-Other (OTO) orders are supported on that symbol.

WebSocket API

  • otoAllowed will now appear on exchangeInfo, that indicates if One-Triggers-the-Other (OTO) orders are supported on that symbol.

SBE

  • A new schema 2:0 spot_2_0.xml has been released. The current schema 1:0 spot_1_0.xml will thus be deprecated, and retired from the API in 6 months as per our schema deprecation policy.
  • When using schema 1:0 on REST API or WebSocket API, group "permissions" in message "ExchangeInfoResponse" will always be empty. Upgrade to schema 2:0 to find permission information in group "permissionSets". See General changes above for more details.
  • Deprecated OCO requests will still be supported by the latest schema.
  • Note that trying to use schema 2:0 before it is actually released will result in an error.

2024-04-02

Notice: The changes below are being rolled out gradually, and will take approximately a week to complete.

General changes:

  • GET /api/v3/account has a new optional parameter omitZeroBalances, which if enabled hides all zero balances.
  • account.status has a new optional parameter omitZeroBalances which if enabled hides all zero balances.
  • The weight of the following requests has been increased from 10 to 25 (This will take effect on April 4, 2024):
    • GET /api/v3/trades
    • GET /api/v3/historicalTrades
    • trades.recent
    • trades.historical

User Data Stream:

  • New event listenKeyExpired that will be emitted in the streams if the listenKey expired.

REST API

  • The POST /api/v3/order/oco endpoint is now deprecated on the REST API. You should use the new POST /api/v3/orderList/oco endpoint instead. Note that this new endpoint uses different parameters.

WebSocket API

  • The orderList.place request is now deprecated on the WebSocket API. You should now use the new orderList.place.oco request instead. Note that this new request uses different parameters.

The following will take effect approximately a week after the release date:

General changes:

  • Symbol permission information in Exchange Information responses has moved from field permissions to field permissionSets.
  • Field permissions will be empty and will be removed in a future release.
  • Previously, "permissions":["SPOT","MARGIN"] meant that you could place an order on the symbol if your account had SPOT or MARGIN permissions. The equivalent is "permissionSets":[["SPOT","MARGIN"]]. (Note the extra set of square brackets.) Each array of permissions inside the permissionSets array is called a "permission set".
  • Symbol permissions can now be more complex. "permissionSets":[["SPOT","MARGIN"],["TRD_GRP_004","TRD_GRP_005"]] means that you may place an order on the symbol if your account has SPOT or MARGIN permissions and TRD_GRP_004 or TRD_GRP_005 permissions. There may be an arbitrary number of permission sets in a symbol's permissionSets.

REST API

  • otoAllowed will now appear on GET /api/v3/exchangeInfo, that indicates if One-Triggers-the-Other (OTO) orders are supported on that symbol.

WebSocket API

  • otoAllowed will now appear on exchangeInfo, that indicates if One-Triggers-the-Other (OTO) orders are supported on that symbol.

SBE

  • A new schema 2:0 spot_2_0.xml has been released. The current schema 1:0 spot_1_0.xml will thus be deprecated, and retired from the API in 6 months as per our schema deprecation policy.
  • When using schema 1:0 on REST API or WebSocket API, group "permissions" in message "ExchangeInfoResponse" will always be empty. Upgrade to schema 2:0 to find permission information in group "permissionSets". See General changes above for more details.
  • Deprecated OCO requests will still be supported by the latest schema.
  • Note that trying to use schema 2:0 before it is actually released will result in an error.

2024-02-28

This will take effect on March 5, 2024.

Simple Binary Encoding (SBE) will be added to the live exchange, both for the Rest API and WebSocket API.

For more information on SBE, please refer to the FAQ

2024-02-08

The SPOT WebSocket API can now support SBE on SPOT Testnet.

The SBE schema has been updated with WebSocket API metadata without incrementing either schemaId or version.

Users using SBE only on the REST API may continue to use the SBE schema with git commit hash 128b94b2591944a536ae427626b795000100cf1d or update to the newly-published SBE schema.

Users who want to use SBE on the WebSocket API must use the newly-published SBE schema.

The FAQ for SBE has been updated.

2023-12-08

Simple Binary Encoding (SBE) has been added to SPOT Testnet.

This will be added to the live exchange at a later date.

For more information on what SBE is, please refer to the FAQ

2023-12-04

Notice: The changes below are being rolled out gradually, and will take approximately a week to complete.

General Changes:

  • Error message Precision is over the maximum defined for this asset. has been changed to Parameter '%s' has too much precision.
    • This error message is returned when a parameter has more precision than allowed: e.g. if base asset precision is 6 and quantity=0.1234567 then this error message will appear.
    • This affects all requests with the following parameters:
      • quantity
      • quoteOrderQty
      • icebergQty
      • limitIcebergQty
      • stopIcebergQty
      • price
      • stopPrice
      • stopLimitPrice
  • Requests for open OCO now correctly return results in ascending order. This affects the following requests:
    • REST API: GET /api/v3/openOrderList
    • WebSocket API: openOrderList.status
  • Requests for all OCO now correctly return results in ascending order when startTime or fromId are specified. This affects the following requests:
    • REST API: GET /api/v3/allOrderList
    • WebSocket API: allOrderLists
  • Fixed a bug where order query requests would incorrectly return -2026 ORDER_ARCHIVED error for newly placed orders.
    • REST API: GET /api/v3/order
    • WebSocket API: order.status

REST API

  • New endpoint GET /api/v3/account/commission
  • New endpoint GET /api/v3/ticker/tradingDay
  • GET /api/v3/avgPrice response has a new field closeTime, indicating the last trade time.
  • GET /api/v3/klines and /api/v3/uiKlines have a new optional parameter timeZone.
  • POST /api/v3/order/test and POST /api/v3/sor/order/test have a new optional parameter computeCommissionRates.
  • Changes regarding invalid endpoints being sent:
    • Previously, if you query an non-existing endpoint (e.g. curl -X GET "https://api.binance.com/api/v3/exchangie) you would get a HTTP 404 code with the response <html><body><h2>404 Not found</h2></body></html>
    • From now on the HTML response will only appear if the Accept request header has text/html for this situation. The HTTP code will remain the same.

WebSocket API

  • New request account.commission
  • New requests to allow session authentication: (Note that these requests can only be used with Ed25519 keys.)
    • session.logon
    • session.logout
    • session.status
  • New request ticker.tradingDay
  • avgPrice response has a new field closeTime, indicating the last trade time.
  • klines and uiKlines have a new optional parameter timeZone.
  • order.test and sor.order.test have a new optional parameter computeCommissionRates.
  • Fixed a bug where unsolicited pongs sent before the ping would cause disconnection.

WebSocket Streams

  • New stream <symbol>@avgPrice
  • id now supports the same values as used for id in the WebSocket API:
    • 64-bit signed integers (previously this was unsigned)
    • Alphanumeric strings, max of 36 in length
    • null
  • Fixed a bug where unsolicited pongs sent before the ping would cause disconnection.

User Data Streams

  • When an event of type executionReport has an execution type (x) of TRADE_PREVENTION, fields l, L and Y will now always be 0. New fields pl, pL and pY will describe the prevented execution quantity, prevented execution price, and prevented execution notional instead. These new fields show the values of what would l, L and Y have been if the taker order didn't have self-trade prevention enabled.

The following will take effect approximately a week after the release date:

  • Symbol Permissions will only affect order placement, not cancellation.
    • permissions still apply to Cancel-Replace orders (i.e. The cancellation won't be allowed if your account does have the permission to place an order using this request.)

2023-10-19

Effective on 2023-10-19 00:00 UTC

  • The request weights of the following requests have been increased:
REST API WebSocket API Condition Previous Request Weight New Request Weight
GET /api/v3/trades trades.recent N/A 2 10
GET /api/v3/depth depth Limit 1-100 2 5
Limit 101-500 10 25
Limit 501-1000 20 50
Limit 1001-5000 100 250

2023-10-03

  • Order decrement feature went live at 06:15 UTC.
  • For more information on this feature, please refer to our FAQ

2023-08-25

  • For WebSocket API, removed RAW REQUESTS rate limit in exchangeInfo, replaced it with CONNECTIONS rate limit, which is the limit for new Websocket connections.

The following changes will be effective from 2023-08-25 at UTC 00:00.

  • The CONNECTIONS rate limit for WebSocket API has been adjusted to 300 every 5 minutes.
  • The REQUEST_WEIGHT rate limit for both REST and WebSocket API has been adjusted to 6,000 every minute.
  • The RAW_REQUESTS rate limit for REST API has been adjusted to 61,000 every 5 minutes.
  • Previously, connecting to WebSocket API used to cost 1 weight. The cost is now 2.
  • The weights to the following requests for both REST API and WebSocket API have been adjusted.

Please refer to the table for more details:

Request Previous Request Weight New Request Weight
GET /api/v3/order
order.status		 2 4
GET /api/v3/orderList
orderList.status		 2 4
GET /api/v3/openOrders
openOrders.status - With symbol		 3 6
GET /api/v3/openOrders
openOrders.status - Without symbol		 40 80
GET /api/v3/openOrderList
openOrderLists.status		 3 6
GET /api/v3/allOrders
allOrders		 10 20
GET /api/v3/allOrderList
allOrderLists		 10 20
GET /api/v3/myTrades
myTrades		 10 20
GET /api/v3/myAllocations
myAllocations		 10 20
GET /api/v3/myPreventedMatches
myPreventedMatches - Using preventedMatchId		 1 2
GET /api/v3/myPreventedMatches
myPreventedMatches - Using orderId		 10 20
GET /api/v3/account
account.status		 10 20
GET /api/v3/rateLimit/order
account.rateLimits.orders		 20 40
GET /api/v3/exchangeInfo
exchangeInfo		 10 20
GET /api/v3/depth
depth - Limit 1-100		 1 2
GET /api/v3/depth
depth - Limit 101-500		 5 10
GET /api/v3/depth
depth - Limit 501-1000		 10 20
GET /api/v3/depth
depth - Limit 1001-5000		 50 100
GET /api/v3/aggTrades
trades.aggregate		 1 2
GET /api/v3/trades
trades.recent		 1 2
GET /api/v3/historicalTrades
trades.historical		 5 10
GET /api/v3/klines
klines		 1 2
GET /api/v3/uiKlines
uiKlines		 1 2
GET /api/v3/ticker/bookTicker
ticker.book - With symbol		 1 2
GET /api/v3/ticker/bookTicker
ticker.book - Without symbol or With symbols		 2 4
GET /api/v3/ticker/price
ticker.price - With symbol		 1 2
GET /api/v3/ticker/price
ticker.price - Without symbol or With symbols		 2 4
GET /api/v3/ticker/24hr
ticker.24hr - With symbol or With symbols using 1-20 symbols		 1 2
GET /api/v3/ticker/24hr
ticker.24hr - With symbols using 21-100 symbols		 20 40
GET /api/v3/ticker/24hr
ticker.24hr - Without symbol or symbols using 101 or more symbols		 40 80
GET /api/v3/avgPrice
avgPrice		 1 2
GET /api/v3/ticker
ticker		 2 4
GET /api/v3/ticker
ticker - Maximum weight for this request		 100 200
POST /api/v3/userDataStream
userDataStream.start		 1 2
PUT /api/v3/userDataStream
userDataStream.ping		 1 2
DELETE /api/v3/userDataStream
userDataStream.stop		 1 2

2023-08-08

Smart Order Routing (SOR) has been added to the APIs. For more information please refer to our FAQ. Please wait for future announcements on when the feature will be enabled.

REST API

  • Changes to GET /api/v3/exchangeInfo:
    • New field in response: sors, describing SORs enabled on the exchange.
  • Changes to GET /api/v3/myPreventedMatches
    • New field makerSymbol will appear in the response for all prevented matches.
  • New endpoints for order placement using SOR:
    • POST /api/v3/sor/order
    • POST /api/v3/sor/order/test
  • New endpoint GET /api/v3/myAllocations

WEBSOCKET API

  • Changes to exchangeInfo:
    • New field in response: sors, describing SORs enabled on the exchange.
  • Changes to myPreventedMatches:
    • New field makerSymbol will appear in the response for all prevented matches.
  • New requests for order placement using SOR:
    • sor.order.place
    • sor.order.test
  • New request myAllocations

USER DATA STREAM

  • Changes to executionReport:
    • These fields are only relevant for orders placed using SOR:
      • New field b for matchType
      • New field a for allocId
      • New field k for workingFloor
    • This field is only relevant for orders expiring due to STP:
      • New field Cs for counterSymbol

2023-07-18

  • New API key type – Ed25519 – is now supported. (UI support will be released this week.)
    • Ed25519 API keys are an alternative to RSA API keys, using asymmetric cryptography to authenticate your requests on the API.
    • We recommend switching to Ed25519 for improved performance and security.
      For more information, please refer to the API Key Types.
  • Documentation has been updated with how to sign a payload with Ed25519 keys.

2023-07-11

Notice: The change below are being rolled out, and will take approximately a week to complete.

General Changes:

  • Changes to error messages:
    • Previously, when duplicate symbols were passed to requests that do not allow it, the error would be "Mandatory parameter symbols was not sent, was empty/null, or malformed."
    • Now, the error message is "Symbol is present multiple times in the list", with a new error code -1151
    • This affects the following requests:
      • GET /api/v3/exchangeInfo
      • GET /api/v3/ticker/24hr
      • GET /api/v3/ticker/price
      • GET/api/v3/ticker/bookTicker
      • exchangeInfo
      • ticker.24hr
      • ticker.price
      • ticker.book
  • Fixed a bug where some non-archived orders being queried would receive the error code that their order was archived.

Rest API

  • Changes to GET /api/v3/account:
    • New field preventSor will appear in the response.
    • New field uid that shows the User Id/Account will appear in the response.
  • Changes to GET /api/v3/historicalTrades:
    • Changed security type from MARKET_DATA to NONE.
    • This means that the X-MBX-APIKEY header is no longer necessary and is now ignored.

Websocket API

  • Changes to account.status:
    • New field preventSor will appear in the response.
    • New field uid that shows the User Id/Account will appear in the response.
  • Changes to trades.historical:
    • Changed security type from MARKET_DATA to NONE.
    • This means that the apiKey parameter is no longer necessary and is now ignored.

The following changes will take effect approximately a week from the release date::

  • Fixed multiple bugs with orders that use type=MARKET and quoteOrderQty, also known as “reverse market orders”:
    • Reverse market orders are no longer partially filled, or filled for zero or negative quantity under extreme market conditions.
    • MARKET_LOT_SIZE filter now correctly rejects reverse market orders that go over the symbol's maxQty.
  • Fixed a bug where OCO orders using trailingDelta could have an incorrect trailingTime value after either leg of the OCO is touched.
  • New field transactTime will appear in order cancellation responses. This affects the following requests:
    • DELETE /api/v3/order
    • POST /api/v3/order/cancelReplace
    • DELETE /api/v3/openOrders
    • DELETE /api/v3/orderList
    • order.cancel
    • order.cancelReplace
    • openOrders.cancelAll
    • orderList.cancel

2023-06-06

  • A new endpoint is now available for redundancy: https://api-gcp.binance.com/
    • This is using the GCP (Google Cloud Platform) CDN and may have slower performance compared to api1-api4 endpoints.

2023-05-26

Notice: The change below are being rolled out, and will take approximately a week to complete.

2023-05-24

  • The previous market data URLs have been deprecated. Please update your code immediately to prevent interruption of our services.
    • API Market data from data.binance.com can now be accessed from data-api.binance.vision.
    • Websocket Market Data from data-stream.binance.com can now be accessed from data-stream.binance.vision.

2023-03-13

Notice: All changes are being rolled out gradually to all our servers, and may take a week to complete.

GENERAL CHANGES

  • The error messages for certain issues have been improved for easier troubleshooting.
Situation Old Error Message New Error Message
An account cannot place or cancel an order, due to trading ability disabled. This action is disabled on this account. This account may not place or cancel orders.
When the permissions configured on the symbol do not match the permissions on the account. This symbol is not permitted for this account.
When the account tries to place an order on a symbol it has no permissions for. This symbol is restricted for this account.
Placing an order when symbol is not TRADING. Unsupported order combination. This order type is not possible in this trading phase.
Placing an order with timeinForce=IOC or FOK on a trading phase that does not support it. Limit orders require GTC for this phase.
  • Fixed error message for querying archived orders:
    • Previously, if an archived order (i.e. order with status CANCELED or EXPIRED where executedQty == 0 that occurred more than 90 days in the past.) is queried, the error message would be:
    {
    "code": -2013,
    "msg": "Order does not exist." 
}
    • Now, the error message is:
    {
    "code": -2026,
    "msg": "Order was canceled or expired with no executed qty over 90 days ago and has been archived." 
}
  • Behavior for API requests with startTime and endTime:
    • Previously some requests failed if the startTime == endTime.
    • Now, all API requests that accept startTime and endTime allow the parameters to be equal. This applies to the following requests:
      • Rest API
        • GET /api/v3/aggTrades
        • GET /api/v3/klines
        • GET /api/v3/allOrderList
        • GET /api/v3/allOrders
        • GET /api/v3/myTrades
      • Websocket API
        • trades.aggregate
        • klines
        • allOrderList
        • allOrders
        • myTrades
  • Users connected to the websocket API will now be disconnected if their IP is banned due to violation of the IP rate limits (status 418).

The following changes will take effect approximately a week from the release date, but the rest of the documentation has been updated to reflect the future changes:

  • Changes to Filter Evaluation:
    • Previous behavior: LOT_SIZE and MARKET_LOT_SIZE required that (quantity - minQty) % stepSize == 0.
    • New behavior: This has now been changed to (quantity % stepSize) == 0.
  • Bug fix with reverse MARKET orders (i.e., MARKET using quoteOrderQty):
    • Previous behavior: Reverse market orders would always have the status FILLED even if the order did not fully fill due to low liquidity.
    • New behavior: If the reverse market order did not fully fill due to low liquidity the order status will be EXPIRED, and FILLED only if the order was completely filled.

REST API

  • Changes to DELETE /api/v3/order and POST /api/v3/order/cancelReplace:
    • A new optional parameter cancelRestrictions that determines whether the cancel will succeed if the order status is NEW or PARTIALLY_FILLED.
    • If the order cancellation fails due to cancelRestrictions, the error will be:
    {
    "code": -2011, 
    "msg": "Order was not canceled due to cancel restrictions."
}

WEBSOCKET API

  • Changes to order.cancel and order.cancelReplace:
    • A new optional parameter cancelRestrictions that determines whether the cancel will succeed if the order status is NEW or PARTIALLY_FILLED.
    • If the order cancellation fails due to cancelRestrictions, the error will be:
    {
    "code": -2011, 
    "msg": "Order was not canceled due to cancel restrictions."
}

2023-02-17

Changes to Websocket Limits

The WS-API and Websocket Stream now only allows 300 connections requests every 5 minutes.

This limit is per IP address.

Please be careful when trying to open multiple connections or reconnecting to the Websocket API.

2023-01-26

As per the announcement, Self Trade Prevention will be enabled at 2023-01-26 08:00 UTC.

Please refer to GET /api/v3/exchangeInfo from the Rest API or exchangeInfo from the Websocket API on the default and allowed modes.

2023-01-23

New API cluster has been added. Note that all endpoints are functionally equal, but may vary in performance.

2023-01-19

ACTUAL RELEASE DATE TBD

New Feature: Self-Trade Prevention (aka STP) will be added to the system at a later date. This will prevent orders from matching with orders from the same account, or accounts under the same tradeGroupId.

Please refer to GET /api/v3/exchangeInfo from the Rest API or exchangeInfo from the Websocket API on the status.

"defaultSelfTradePreventionMode": "NONE",   //If selfTradePreventionMode not provided, this will be the value passed to the engine
"allowedSelfTradePreventionModes": [        //What the allowed modes of selfTradePrevention are
    "NONE",
    "EXPIRE_TAKER",
    "EXPIRE_BOTH",
    "EXPIRE_MAKER"
]

Additional details on the functionality of STP is explained in the STP FAQ document.

REST API

  • New order status: EXPIRED_IN_MATCH - This means that the order expired due to STP being triggered.
  • New endpoint:
    • GET /api/v3/myPreventedMatches - This queries the orders that expired due to STP being triggered.
  • New optional parameter selfTradePreventionMode has been added to the following endpoints:
    • POST /api/v3/order
    • POST /api/v3/order/oco
    • POST /api/v3/cancelReplace
  • New responses that will appear for all order placement endpoints if there was a prevented match (i.e. if an order could have matched with an order of the same account, or the accounts are in the same tradeGroupId):
    • tradeGroupId - This will only appear if account is configured to a tradeGroupId and if there was a prevented match.
    • preventedQuantity - Only appears if there was a prevented match.
    • An array preventedMatches with the following fields:
      • preventedMatchId
      • makerOrderId
      • price
      • takerPreventedQuantity - This will only appear if selfTradePreventionMode set is EXPIRE_TAKER or EXPIRE_BOTH.
      • makerPreventedQuantity - This will only appear if selfTradePreventionMode set is EXPIRE_MAKER or EXPIRE_BOTH.
  • New fields preventedMatchId and preventedQuantity that can appear in the order query endpoints if the order had expired due to an STP trigger:
    • GET /api/v3/order
    • GET /api/v3/openOrders
    • GET /api/v3/allOrders

WEBSOCKET API

  • New order status: EXPIRED_IN_MATCH - This means that the order expired due to STP being triggered.
  • New optional parameter selfTradePreventionMode has been added to the following requests:
    • order.place
    • orderList.place
    • order.cancelReplace
  • New request: myPreventedMatches - This queries the orders that expired due to STP being triggered.
  • New responses that will appear for all order placement endpoints if there was a prevented match (i.e. if an order could have matched with an order of the same account, or the accounts are in the same tradeGroupId):
    • tradeGroupId - This will only appear if account is configured to a tradeGroupId and if there was a prevented match.
    • preventedQuantity - Only appears if there was a prevented match.
    • An array preventedMatches with the following fields:
      • preventedMatchId
      • makerOrderId
      • price
      • takerPreventedQuantity - This will only appear if selfTradePreventionMode set is EXPIRE_TAKER or EXPIRE_BOTH.
      • makerPreventedQuantity - This will only appear if selfTradePreventionMode set is EXPIRE_MAKER or EXPIRE_BOTH.
  • New fields preventedMatchId and preventedQuantity that can appear in the order query requests if the order had expired due to STP trigger:
    • order.status
    • openOrders.status
    • allOrders

USER DATA STREAM

  • New execution Type: TRADE_PREVENTION
  • New fields for executionReport (These fields will only appear if the order has expired due to STP trigger)
    • u - tradeGroupId
    • v - preventedMatchId
    • U - counterOrderId
    • A - preventedQuantity
    • B - lastPreventedQuantity

2022-12-28

  • SPOT WebSocket API documentation has been updated to show how to sign a request using an RSA key.

2022-12-26

  • Spot WebSocket API is now available on the live exchange.
  • Spot Websocket API can be accessed through this URL: wss://ws-api.binance.com/ws-api/v3

2022-12-15

  • New RSA signature
    • Documentation has been updated to show how to create RSA keys.
    • For security reasons, we recommend to use RSA keys instead of HMAC keys when generating an API key.
    • We accept PKCS#8 (BEGIN PUBLIC KEY).
    • More details on how to upload your RSA public key will be added at a later date.
  • SPOT WebSocket API is now available on SPOT Testnet.
    • WebSocket API allows placing orders, canceling orders, etc. through a WebSocket connection.
    • WebSocket API is a separate service from WebSocket Market Data streams. I.e., placing orders and listening to market data requires two separate WebSocket connections.
    • WebSocket API is subject to the same Filter and Rate Limit rules as REST API.
    • WebSocket API and REST API are functionally equivalent: they provide the same features, accept the same parameters, return the same status and error codes.

WEBSOCKET API WILL BE AVAILABLE ON THE LIVE EXCHANGE AT A LATER DATE.

2022-12-13

REST API

Some error messages on error code -1003 have changed.

  • Previous error message: Too much request weight used; current limit is %s request weight per %s %s. Please use the websocket for live updates to avoid polling the API. has been updated to:
Too much request weight used; current limit is %s request weight per %s. Please use WebSocket Streams for live updates to avoid polling the API.
  • Previous error message Way too much request weight used; IP banned until %s. Please use the websocket for live updates to avoid bans. has been updated to:
Way too much request weight used; IP banned until %s. Please use WebSocket Streams for live updates to avoid bans.

2022-12-05

Notice: These changes are being rolled out gradually to all our servers, and will take approximately a week to complete.

WEBSOCKET

  • !bookTicker will be removed by December 7, 2022. Please use the Individual Book Ticker Streams instead (<symbol>@bookTicker).
    • Multiple <symbol>@bookTicker streams can be subscribed to over one connection. (E.g. wss://stream.binance.com:9443/stream?streams=btcusdt@bookTicker/bnbbtc@bookTicker)

REST API

  • New error code -1135
    • This error code will occur if a parameter requiring a JSON object is invalid.
  • New error code -1108
    • This error will occur if a value to a parameter being sent was too large, potentially causing overflow.
    • This error code can occur in the following endpoints:
      • POST /api/v3/order
      • POST /api/v3/order/cancelReplace
      • POST /api/v3/order/oco
  • Changes to GET /api/v3/aggTrades
    • Previous behavior: startTime and endTime had to be used in combination and could only be an hour apart.
    • New behavior: startTime and endTime can be used individually and the 1 hour limit has been removed.
      • When using startTime only, this will return trades from that time, up to the limit provided.
      • When using endTime only, this will return trades before that time, up to the limit provided.
      • If limit not provided, regardless of used in combination or sent individually, the endpoint will use the default limit.
  • Changes to GET /api/v3/myTrades

    • Fixed a bug where symbol + orderId combination would return all trades even if the number of trades went beyond the 500 default limit.

    • Previous behavior: The API would send specific error messages depending on the combination of parameters sent. E.g:

          {
        "code": -1106,
        "msg": "Parameter X was sent when not required."
    }

    • New behavior: If the combinations of optional parameters to the endpoint were not supported, then the endpoint will respond with the generic error:

          {
        "code": -1128,
        "msg": "Combination of optional parameters invalid."
    }

    • Added a new combination of supported parameters: symbol + orderId + fromId.

    • The following combinations of parameters were previously supported but no longer accepted, as these combinations were only taking fromId into consideration, ignoring startTime and endTime:

      • symbol + fromId + startTime
      • symbol + fromId + endTime
      • symbol + fromId + startTime + endTime

    • Thus, these are the supported combinations of parameters:

      • symbol
      • symbol + orderId
      • symbol + startTime
      • symbol + endTime
      • symbol + fromId
      • symbol + startTime + endTime
      • symbol+ orderId + fromId

Note: These new fields will appear approximately a week from the release date.

  • Changes to GET /api/v3/exchangeInfo
    • New fields defaultSelfTradePreventionMode and allowedSelfTradePreventionModes
  • Changes to the Order Placement Endpoints/Order Query/Order Cancellation Endpoints:
    • New field selfTradePreventionMode will appear in the response.
    • Affects the following endpoints:
      • POST /api/v3/order
      • POST /api/v3/order/oco
      • POST /api/v3/order/cancelReplace
      • GET /api/v3/order
      • DELETE /api/v3/order
      • DELETE /api/v3/orderList
  • Changes to GET /api/v3/account
    • New field requireSelfTradePrevention will appear in the response.
  • New field workingTime, indicating when the order started working on the order book, will appear in the following endpoints:
    • POST /api/v3/order
    • GET /api/v3/order
    • POST /api/v3/order/cancelReplace
    • POST /api/v3/order/oco
    • GET /api/v3/order
    • GET /api/v3/openOrders
    • GET /api/v3/allOrders
  • Field trailingTime, indicating the time when the trailing order is active and tracking price changes, will appear for the following order types (TAKE_PROFIT, TAKE_PROFIT_LIMIT, STOP_LOSS, STOP_LOSS_LIMIT if trailingDelta parameter was provided) for the following endpoints:
    • POST /api/v3/order
    • GET /api/v3/order
    • GET /api/v3/openOrders
    • GET /api/v3/allOrders
    • POST /api/v3/order/cancelReplace
    • DELETE /api/v3/order
  • Field commissionRates will appear in the GET /api/v3/acccount response

USER DATA STREAM

  • eventType executionReport has new fields
    • V - selfTradePreventionMode
    • D - trailing_time (Appears if the trailing stop order is active)
    • W - workingTime (Appears if isWorking=true)

2022-12-02

  • Added a new market data base URL https://data.binance.com.
  • Added a new WebSocket URL wss://data-stream.binance.com.

2022-09-30

Scheduled changes to the removal of !bookTicker around November 2022.

  • The All Book Tickers stream (!bookTicker) is set to be removed in November 2022.
  • More details of the actual removal date will be announced at a later time.
  • Please use the Individual Book Ticker Streams instead. (<symbol>@bookTicker).
  • Multiple <symbol>@bookTicker streams can be subscribed to over one connection.
    • Example: wss://stream.binance.com:9443/stream?streams=btcusdt@bookTicker/bnbbtc@bookTicker

2022-09-15

Note that these are rolling changes, so it may take a few days for it to rollout to all our servers.

  • Changes to GET /api/v3/exchangeInfo
    • New optional parameter permissions added to display all symbols with the permissions matching the parameter provided. (eg.SPOT,MARGIN)
    • If not provided, the default value will be ["SPOT","MARGIN","LEVERAGED"].
      • This means the request GET /api/v3/exchangeInfo without any parameters will show all symbols that can be used for SPOT, MARGIN, and/or LEVERAGED trading.
      • To search for symbols that can be traded on other permissions (e.g. TRD_GRP_004, etc), then this needs to be searched for explicitly. (e.g.permissions=TRD_GRP_004)
    • Cannot be combined with symbol or symbols

2022-08-23

Note that these are rolling changes, so it may take a few days for it to rollout to all our servers.

  • Changes to GET /api/v3/ticker and GET /api/v3/ticker/24hr
    • New optional parameter type added
    • Supported values for parameter type are FULL and MINI
      • FULL is the default value and the response that is currently being returned from the endpoint
      • MINI omits the following fields from the response: priceChangePercent, weightedAvgPrice, bidPrice, bidQty, askPrice, askQty, and lastQty
  • New error code -1008
    • This is sent whenever the servers are overloaded with requests.
  • New field brokered has been added to GET /api/v3/account
  • New kline interval: 1s
  • New endpoint added: GET /api/v3/uiKlines

2022-08-08

REST API

  • Changes to POST /api/v3/order and POST /api/v3/order/cancelReplace
    • New optional fields strategyId and strategyType
      • strategyId is a parameter used to identify an order as part of a strategy.
      • strategyType is a parameter used to identify what strategy was running. (E.g. If all the orders are part of spot grid strategy, it can be set to strategyType=1000000)
        • Note that the minimum value allowed for strategyType is 1000000.
  • Changes to POST /api/v3/order/oco
    • New optional fields limitStrategyId, limitStrategyType, stopStrategyId, stopStrategyType
    • These are the strategy metadata parameters for both legs of the OCO orders.
    • limitStrategyType and stopStrategyType both cannot be less than 1000000.
  • Changes to GET /api/v3/order, GET /api/v3/openOrders, and GET /api/v3/allOrders
    • New fields strategyId and strategyType will appear in the response JSON for orders that had these fields populated upon order placement.
  • Changes to DELETE /api/v3/order and DELETE /api/v3/openOrders
    • New fields strategyId and strategyType will appear in the response JSON for cancelled orders that had these fields populated upon order placement.

USER DATA STREAM

  • New fields to eventType executionReport
    • j for strategyId
    • J for strategyType
    • Note that these fields only appear if these were populated upon order placement.

2022-06-20

Changes to GET /api/v3/ticker

  • Weight has been reduced from 5 to 2 per symbol, regardless of windowSize.
  • The max number of symbols that can be processed in a request is 100.
    • If the number of symbols sent is more than 100, the error will be as follows:
    {
 "code": -1101,
 "msg": "Too many values sent for parameter 'symbols', maximum allowed up to 100."
}
  • The max Weight for this endpoint will cap at 100.
    • I.e. If the request has more than 50 symbols, the Weight will still be 100, regardless of windowSize.

2022-06-15

Note: The update is being rolled out over the next few days, so these changes may not be visible right away.

SPOT API

  • GET /api/v3/ticker added
    • Rolling window price change statistics based on windowSize provided.
    • Contrary to GET /api/v3/ticker/24hr the list of symbols cannot be omitted.
    • If windowSize not specified, the value will default to 1d.
    • Response is similar to GET /api/v3/ticker/24hr, minus the following fields: prevClosePrice, lastQty, bidPrice, bidQty, askPrice, askQty
  • GET /api/v3/exchangeInfo returns new field cancelReplaceAllowed in symbols list.
  • POST /api/v3/order/cancelReplace added
    • Cancels an existing order and places a new order on the same symbol.
    • The filters are evaluated before the cancel order is placed.
      • e.g. If the MAX_NUM_ORDERS filter is 10, and the total number of open orders on the account is also 10, when using POST /api/v3/order/cancelReplace both the cancel order placement and new order will fail because of the filter.
    • The change is being rolled out in the next few days, thus this feature will be enabled once the upgrade is completed.
  • New filter NOTIONAL has been added.
    • Defines the allowed notional value (price * quantity) based on a configured minNotional and maxNotional
  • New exchange filter EXCHANGE_MAX_NUM_ICEBERG_ORDERS has been added.
    • Defines the limit of open iceberg orders on an account

2022-05-23

  • Changes to Order Book Depth Levels

    • Quantities in the Depth levels were returning negative values in situations where they were exceeding the max value, resulting in an overflow.
    • Going forward depth levels will not overflow, but will be capped at the max value based on the precision of the base asset. This means that the depth level is at max value or more.
      • E.g. If the precision is 8, then the max value for quantity will be at 92,233,720,368.54775807.
    • When the fix has been applied, a change in the order book at the affected price level is required for the changes to be visible.

  • What does this affect?

    • SPOT API
      • GET /api/v3/depth
    • Websocket Streams
      • <symbol>@depth
      • <symbol>@depth@100ms
      • <symbol>@depth<levels>
      • <symbol>@depth<levels>@100ms

  • Updates to MAX_POSITION

    • If an order's quantity can cause the position to overflow, this will now fail the MAX_POSITION filter.

2022-05-17

  • Changes to GET api/v3/aggTrades
    • When providing startTime and endTime, the oldest items are returned.
  • Changed error messaging on GET /api/v3/myTrades where parameter symbol is not provided:
{
"code": -1102,
"msg": "Mandatory parameter 'symbol' was not sent, was empty/null, or malformed."
}
  • The following endpoints now support multi-symbol querying using the parameter symbols.
    • GET /api/v3/ticker/24hr
    • GET /api/v3/ticker/price
    • GET /api/v3/ticker/bookTicker
  • In the above, the request weight will depend on the number of symbols provided in symbols.
    Please refer to the table below:
Endpoint Number of Symbols Weight
GET /api/v3/ticker/price Any 2
GET /api/v3/ticker/bookTicker Any 2
GET /api/v3/ticker/24hr 1-20 1
GET /api/v3/ticker/24hr 21-100 20
GET /api/v3/ticker/24hr 101 or more 40

2022-04-13

REST API

  • Trailing Stops have been enabled.
    • This is a type of algo order where the activation is based on a percentage of a price change in the market using the new parameter trailingDelta.
    • This can only used with any of the following order types: STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT.
    • The trailingDelta parameter will be done in Basis Points or BIPS.
      • For example: a STOP_LOSS SELL order with a trailingDelta of 100 will trigger after a price decrease of 1% from the highest price after the order is placed. (100 / 10,000 => 0.01 => 1%)
    • When used in combination with OCO Orders, the trailingDelta will determine when the contingent leg of the OCO will trigger.
    • When trailingDelta is used in combination with stopPrice, once the stopPrice condition is met, the trailing stop starts tracking the price change from the stopPrice based on the trailingDelta provided.
    • When no stopPrice is sent, the trailing stop starts tracking the price changes from the last price based on the trailingDelta provided.
  • Changes to POST /api/v3/order
    • New optional field trailingDelta
  • Changes to POST /api/v3/order/test
    • New optional field trailingDelta
  • Changes to POST /api/v3/order/oco
    • New optional field trailingDelta
  • A new filter TRAILING_DELTA has been added.
    • This filter is defined by the minimum and maximum values for the trailingDelta value.

USER DATA STREAM

  • New field in executionReport
    • "d" for trailingDelta

2022-04-12

Note: The changes are being rolled out during the next few days, so these will not appear right away.

  • Error message changed on GET api/v3/allOrders where symbol is not provided: 
    {
 "code": -1102,
 "msg": "Mandatory parameter 'symbol' was not sent, was empty/null, or malformed."
}
  • Fixed a typo with an error message when an account has disabled permissions (e.g. to withdraw, to trade, etc) 
    "This action is disabled on this account."
  • During a market data audit, we detected some issues with the Spot aggregate trade data.
    • Missing aggregate trades were recovered.
    • Duplicated records were marked invalid with the following values:
      • p = '0' // price
      • q = '0' // qty
      • f = -1 // first_trade_id
      • l = -1 // last_trade_id

2022-02-28

  • New field allowTrailingStop has been added to GET /api/v3/exchangeInfo

2022-02-24

  • (price-minPrice) % tickSize == 0 rule in PRICE_FILTER has been changed to price % tickSize == 0.
  • A new filter PERCENT_PRICE_BY_SIDE has been added.
  • Changes to GET api/v3/depth
    • The limit value can be outside of the previous values (i.e. 5, 10, 20, 50, 100, 500, 1000,5000) and will return the correct limit. (i.e. if limit=3 then the response will be the top 3 bids and asks)
    • The limit still cannot exceed 5000. If the limit provided is greater than 5000, then the response will be truncated to 5000.
    • Due to the changes, these are the updated request weights based on the limit value provided:
Limit Request Weight
1-100 1
101-500 5
501-1000 10
1001-5000 50
  • Changes to GET api/v3/aggTrades
    • When providing startTime and endTime, the oldest items are returned.

2021-12-29

  • Removed out dated "Symbol Type" enum; added "Permissions" enum.

2021-11-01

  • GET /api/v3/rateLimit/order added
    • The endpoint will display the user's current order count usage for all intervals.
    • This endpoint will have a request weight of 20.

2021-09-14

  • Add a YAML file with OpenApi specification on the RESTful API.

2021-08-12

  • GET api/v3/myTrades has a new optional field orderId

2021-05-12

  • Added Data Source in the documentation to explain where each endpoint is retrieving its data.
  • Added field Data Source to each API endpoint in the documentation
  • GET api/v3/exchangeInfo now supports single or multi-symbol query

2021-04-26

On April 28, 2021 00:00 UTC the weights to the following endpoints will be adjusted:

  • GET /api/v3/order weight increased to 2
  • GET /api/v3/openOrders weight increased to 3
  • GET /api/v3/allOrders weight increased to 10
  • GET /api/v3/orderList weight increased to 2
  • GET /api/v3/openOrderList weight increased to 3
  • GET /api/v3/account weight increased to 10
  • GET /api/v3/myTrades weight increased to 10
  • GET /api/v3/exchangeInfo weight increased to 10

2021-01-01

USER DATA STREAM

  • outboundAccountInfo has been removed.

2020-11-27

New API clusters have been added in order to improve performance.

Users can access any of the following API clusters, in addition to api.binance.com

If there are any performance issues with accessing api.binance.com please try any of the following instead:

2020-09-09

USER DATA STREAM

  • outboundAccountInfo has been deprecated.
  • outboundAccountInfo will be removed in the future. (Exact date unknown) Please use outboundAccountPosition instead.
  • outboundAccountInfo will now only show the balance of non-zero assets and assets that have been reduced to 0.

2020-05-01

  • From 2020-05-01 UTC 00:00, all symbols will have a limit of 200 open orders using the MAX_NUM_ORDERS filter.
    • No existing orders will be removed or canceled.
    • Accounts that have 200 or more open orders on a symbol will not be able to place new orders on that symbol until the open order count is below 200.
    • OCO orders count as 2 open orders before the LIMIT order is touched or the STOP_LOSS (or STOP_LOSS_LIMIT) order is triggered; once this happens the other order is canceled and will no longer count as an open order.

2020-04-25

REST API

  • New field permissions
    • Defines the trading permissions that are allowed on accounts and symbols.
    • permissions is an enum array; values:
      • SPOT
      • MARGIN
    • permissions will replace isSpotTradingAllowed and isMarginTradingAllowed on GET api/v3/exchangeInfo in future API versions (v4+).
    • For an account to trade on a symbol, the account and symbol must share at least 1 permission in common.
  • Updates to GET api/v3/exchangeInfo
    • New field permissions added.
    • New field quoteAssetPrecision added; a duplicate of the quotePrecision field. quotePrecision will be removed in future API versions (v4+).
  • Updates to GET api/v3/account
    • New field permissions added.
  • New endpoint DELETE api/v3/openOrders
    • This will allow a user to cancel all open orders on a single symbol.
    • This endpoint will cancel all open orders including OCO orders.
  • Orders can be canceled via the API on symbols in the BREAK or HALT status.

USER DATA STREAM

  • OutboundAccountInfo has new field P which shows the trading permissions of the account.

2020-04-23

WEB SOCKET STREAM

  • WebSocket connections have a limit of 5 incoming messages per second. A message is considered:
    • A PING frame
    • A PONG frame
    • A JSON control message (e.g. subscribe, unsubscribe)
  • A connection that goes beyond the limit will be disconnected; IPs that are repeatedly disconnected may be banned.
  • A single connection can listen to a maximum of 1024 streams.

2020-03-24

  • MAX_POSITION filter added.

    • This filter defines the allowed maximum position an account can have on the base asset of a symbol. An account's position defined as the sum of the account's:

      • free balance of the base asset
      • locked balance of the base asset
      • sum of the qty of all open BUY orders

    • BUY orders will be rejected if the account's position is greater than the maximum position allowed.

2019-11-22

  • Quote Order Qty Market orders have been enabled on all symbols.
    • Quote Order Qty MARKET orders allow a user to specify the total quoteOrderQty spent or received in the MARKET order.
    • Quote Order Qty MARKET orders will not break LOT_SIZE filter rules; the order will execute a quantity that will have the notional value as close as possible to quoteOrderQty.
    • Using BNBBTC as an example:
      • On the BUY side, the order will buy as many BNB as quoteOrderQty BTC can.
      • On the SELL side, the order will sell as much BNB as needed to receive quoteOrderQty BTC.

2019-11-13

REST API

  • api/v3/exchangeInfo has new fields:
    • quoteOrderQtyMarketAllowed
    • baseCommissionDecimalPlaces
    • quoteCommissionDecimalPlaces
  • MARKET orders have a new optional field: quoteOrderQty used to specify the quote quantity to BUY or SELL. This cannot be used in combination with quantity.
    • The exact timing that quoteOrderQty MARKET orders will be enabled is TBD. There will be a separate announcement and further details at that time.
  • All order query endpoints will return a new field origQuoteOrderQty in the JSON payload. (e.g. GET api/v3/allOrders)
  • Updated error messages for -1128
    • Sending an OCO with a stopLimitPrice but without a stopLimitTimeInForce will return the error:
     {
  "code": -1128,
  "msg": "Combination of optional parameters invalid. Recommendation: 'stopLimitTimeInForce' should also be sent."
 }
  • Updated error messages for -1003 to specify the limit is referring to the request weight, not to the number of requests.

Deprecation of v1 endpoints:

By end of Q1 2020, the following endpoints will be removed from the API. The documentation has been updated to use the v3 versions of these endpoints.

  • GET api/v1/depth
  • GET api/v1/historicalTrades
  • GET api/v1/aggTrades
  • GET api/v1/klines
  • GET api/v1/ticker/24hr
  • GET api/v1/ticker/price
  • GET api/v1/exchangeInfo
  • POST api/v1/userDataStream
  • PUT api/v1/userDataStream
  • GET api/v1/ping
  • GET api/v1/time
  • GET api/v1/ticker/bookTicker

These endpoints however, will NOT be migrated to v3. Please use the following endpoints instead moving forward.

Old V1 Endpoints New V3 Endpoints
GET api/v1/ticker/allPrices GET api/v3/ticker/price
GET api/v1/ticker/allBookTickers GET api/v3/ticker/bookTicker

USER DATA STREAM

  • Changes toexecutionReport event

    • If the C field is empty, it will now properly return null, instead of "null".
    • New field Q which represents the quoteOrderQty.

  • balanceUpdate event type added

    • This event occurs when funds are deposited or withdrawn from your account.

WEB SOCKET STREAMS

  • WSS now supports live subscribing/unsubscribing to streams.

2019-09-09

  • New WebSocket streams for bookTickers added: <symbol>@bookTicker and !bookTicker. See web-socket-streams.md for details.

2019-09-03

  • Faster order book data with 100ms updates: <symbol>@depth@100ms and <symbol>@depth#@100ms
  • Added "Update Speed:" to web-socket-streams.md
  • Removed deprecated v1 endpoints as per previous announcement:
    • GET api/v1/order
    • GET api/v1/openOrders
    • POST api/v1/order
    • DELETE api/v1/order
    • GET api/v1/allOrders
    • GET api/v1/account
    • GET api/v1/myTrades

2019-08-16 (Update 2)

  • GET api/v1/depth limit of 10000 has been temporarily removed

2019-08-16

  • In Q4 2017, the following endpoints were deprecated and removed from the API documentation. They have been permanently removed from the API as of this version. We apologize for the omission from the original changelog:

    • GET api/v1/order
    • GET api/v1/openOrders
    • POST api/v1/order
    • DELETE api/v1/order
    • GET api/v1/allOrders
    • GET api/v1/account
    • GET api/v1/myTrades

  • Streams, endpoints, parameters, payloads, etc. described in the documents in this repository are considered official and supported. The use of any other streams, endpoints, parameters, or payloads, etc. is not supported; use them at your own risk and with no guarantees.

2019-08-15

REST API

  • New order type: OCO ("One Cancels the Other")

    • An OCO has 2 orders: (also known as legs in financial terms)

      • STOP_LOSS or STOP_LOSS_LIMIT leg
      • LIMIT_MAKER leg

    • Price Restrictions:

      • SELL Orders : Limit Price > Last Price > Stop Price
      • BUY Orders : Limit Price < Last Price < Stop Price
      • As stated, the prices must "straddle" the last traded price on the symbol. EX: If the last price is 10:
        • A SELL OCO must have the limit price greater than 10, and the stop price less than 10.
        • A BUY OCO must have a limit price less than 10, and the stop price greater than 10.

    • Quantity Restrictions:

      • Both legs must have the same quantity.
      • ICEBERG quantities however, do not have to be the same.

    • Execution Order:

      • If the LIMIT_MAKER is touched, the limit maker leg will be executed first BEFORE canceling the Stop Loss Leg.
      • if the Market Price moves such that the STOP_LOSS or STOP_LOSS_LIMIT will trigger, the Limit Maker leg will be canceled BEFORE executing the STOP_LOSS Leg.

    • Canceling an OCO

      • Canceling either order leg will cancel the entire OCO.
      • The entire OCO can be canceled via the orderListId or the listClientOrderId.

    • New Enums for OCO:

      1. ListStatusType
        • RESPONSE - used when ListStatus is responding to a failed action. (either order list placement or cancellation)
        • EXEC_STARTED - used when an order list has been placed or there is an update to a list's status.
        • ALL_DONE - used when an order list has finished executing and is no longer active.
      2. ListOrderStatus
        • EXECUTING - used when an order list has been placed or there is an update to a list's status.
        • ALL_DONE - used when an order list has finished executing and is no longer active.
        • REJECT - used when ListStatus is responding to a failed action. (either order list placement or cancellation)
      3. ContingencyType
        • OCO - specifies the type of order list.

    • New Endpoints:

      • POST api/v3/order/oco
      • DELETE api/v3/orderList
      • GET api/v3/orderList

  • recvWindow cannot exceed 60000.

  • New intervalLetter values for headers:

    • SECOND => S
    • MINUTE => M
    • HOUR => H
    • DAY => D

  • New Headers X-MBX-USED-WEIGHT-(intervalNum)(intervalLetter) will give your current used request weight for the (intervalNum)(intervalLetter) rate limiter. For example, if there is a one minute request rate weight limiter set, you will get a X-MBX-USED-WEIGHT-1M header in the response. The legacy header X-MBX-USED-WEIGHT will still be returned and will represent the current used weight for the one minute request rate weight limit.

  • New Header X-MBX-ORDER-COUNT-(intervalNum)(intervalLetter)that is updated on any valid order placement and tracks your current order count for the interval; rejected/unsuccessful orders are not guaranteed to have X-MBX-ORDER-COUNT-** headers in the response.

    • Eg. X-MBX-ORDER-COUNT-1S for "orders per 1 second" and X-MBX-ORDER-COUNT-1D for orders per "one day"

  • GET api/v1/depth now supports limit 5000 and 10000; weights are 50 and 100 respectively.

  • GET api/v1/exchangeInfo has a new parameter ocoAllowed.

USER DATA STREAM

  • executionReport event now contains "g" which has the orderListId; it will be set to -1 for non-OCO orders.
  • New Event Type listStatus; listStatus is sent on an update to any OCO order.
  • New Event Type outboundAccountPosition; outboundAccountPosition is sent any time an account's balance changes and contains the assets that could have changed by the event that generated the balance change (a deposit, withdrawal, trade, order placement, or cancellation).

NEW ERRORS

  • -1131 BAD_RECV_WINDOW
    • recvWindow must be less than 60000
  • -1099 Not found, authenticated, or authorized
    • This replaces error code -1999

NEW -2011 ERRORS

  • OCO_BAD_ORDER_PARAMS
    • A parameter for one of the orders is incorrect.
  • OCO_BAD_PRICES
    • The relationship of the prices for the orders is not correct.
  • UNSUPPORTED_ORD_OCO
    • OCO orders are not supported for this symbol.

2019-03-12

REST API

  • X-MBX-USED-WEIGHT header added to Rest API responses.
  • Retry-After header added to Rest API 418 and 429 responses.
  • When canceling the Rest API can now return errorCode -1013 OR -2011 if the symbol's status isn't TRADING.
  • api/v1/depth no longer has the ignored and empty [].
  • api/v3/myTrades now returns quoteQty; the price * qty of for the trade.

WEBSOCKET STREAMS

  • <symbol>@depth and <symbol>@depthX streams no longer have the ignored and empty [].

SYSTEM IMPROVEMENTS

  • Matching Engine stability/reliability improvements.
  • Rest API performance improvements.

2018-11-13

REST API

  • Can now cancel orders through the Rest API during a trading ban.
  • New filters: PERCENT_PRICE, MARKET_LOT_SIZE, MAX_NUM_ICEBERG_ORDERS.
  • Added RAW_REQUESTS rate limit. Limits based on the number of requests over X minutes regardless of weight.
  • /api/v3/ticker/price increased to weight of 2 for a no symbol query.
  • /api/v3/ticker/bookTicker increased weight of 2 for a no symbol query.
  • DELETE /api/v3/order will now return an execution report of the final state of the order.
  • MIN_NOTIONAL filter has two new parameters: applyToMarket (whether or not the filter is applied to MARKET orders) and avgPriceMins (the number of minutes over which the price averaged for the notional estimation).
  • intervalNum added to /api/v1/exchangeInfo limits. intervalNum describes the amount of the interval. For example: intervalNum 5, with interval minute, means "every 5 minutes".

Explanation for the average price calculation:

  1. (qty * price) of all trades / sum of qty of all trades over previous 5 minutes.

  2. If there is no trade in the last 5 minutes, it takes the first trade that happened outside of the 5min window. For example if the last trade was 20 minutes ago, that trade's price is the 5 min average.

  3. If there is no trade on the symbol, there is no average price and market orders cannot be placed. On a new symbol with applyToMarket enabled on the MIN_NOTIONAL filter, market orders cannot be placed until there is at least 1 trade.

  4. The current average price can be checked here: https://api.binance.com/api/v3/avgPrice?symbol=<symbol> For example: https://api.binance.com/api/v3/avgPrice?symbol=BNBUSDT

USER DATA STREAM

  • Last quote asset transacted quantity (as variable Y) added to execution reports. Represents the lastPrice * lastQty (L * l).

2018-07-18

REST API

  • New filter: ICEBERG_PARTS
  • POST api/v3/order new defaults for newOrderRespType. ACK, RESULT, or FULL; MARKET and LIMIT order types default to FULL, all other orders default to ACK.
  • POST api/v3/order RESULT and FULL responses now have cummulativeQuoteQty
  • GET api/v3/openOrders with no symbol weight reduced to 40.
  • GET api/v3/ticker/24hr with no symbol weight reduced to 40.
  • Max amount of trades from GET /api/v1/trades increased to 1000.
  • Max amount of trades from GET /api/v1/historicalTrades increased to 1000.
  • Max amount of aggregate trades from GET /api/v1/aggTrades increased to 1000.
  • Max amount of aggregate trades from GET /api/v1/klines increased to 1000.
  • Rest API Order lookups now return updateTime which represents the last time the order was updated; time is the order creation time.
  • Order lookup endpoints will now return cummulativeQuoteQty. If cummulativeQuoteQty is < 0, it means the data isn't available for this order at this time.
  • REQUESTS rate limit type changed to REQUEST_WEIGHT. This limit was always logically request weight and the previous name for it caused confusion.

USER DATA STREAM

  • cummulativeQuoteQty field added to order responses and execution reports (as variable Z). Represents the cummulative amount of the quote that has been spent (with a BUY order) or received (with a SELL order). Historical orders will have a value < 0 in this field indicating the data is not available at this time. cummulativeQuoteQty divided by cummulativeQty will give the average price for an order.
  • O (order creation time) added to execution reports

2018-01-23

  • GET /api/v1/historicalTrades weight decreased to 5
  • GET /api/v1/aggTrades weight decreased to 1
  • GET /api/v1/klines weight decreased to 1
  • GET /api/v1/ticker/24hr all symbols weight decreased to number of trading symbols / 2
  • GET /api/v3/allOrders weight decreased to 5
  • GET /api/v3/myTrades weight decreased to 5
  • GET /api/v3/account weight decreased to 5
  • GET /api/v1/depth limit=500 weight decreased to 5
  • GET /api/v1/depth limit=1000 weight decreased to 10
  • -1003 error message updated to direct users to websockets

2018-01-20

  • GET /api/v1/ticker/24hr single symbol weight decreased to 1
  • GET /api/v3/openOrders all symbols weight decreased to number of trading symbols / 2
  • GET /api/v3/allOrders weight decreased to 15
  • GET /api/v3/myTrades weight decreased to 15
  • GET /api/v3/order weight decreased to 1
  • myTrades will now return both sides of a self-trade/wash-trade

2018-01-14

  • GET /api/v1/aggTrades weight changed to 2
  • GET /api/v1/klines weight changed to 2
  • GET /api/v3/order weight changed to 2
  • GET /api/v3/allOrders weight changed to 20
  • GET /api/v3/account weight changed to 20
  • GET /api/v3/myTrades weight changed to 20
  • GET /api/v3/historicalTrades weight changed to 20