CHANGELOG for Binance's API
Last Updated: 2025-09-29
2025-09-29
Notice: The following changes will be deployed on 2025-09-29, starting at 10:00 UTC and may take several hours to complete.
- Added an endpoint to retrieve the list of filters relevant to an account on a given symbol. This is the only endpoint that shows if an account has
MAX_ASSET
filters applied to it.- REST API:
GET /api/v3/myFilters
- WebSocket API:
myFilters
- REST API:
- Comments in SBE: schema 3:1 (spot_3_1.xml) have been added, modified, and removed. Although there is no need for users of
3:1
to update to this version of the file, we advise updating to maintain consistency. - Added documentation for filter
MAX_ASSET
.
2025-09-18
- Updated documentation for
recvWindow
to reflect microsecond support announced on 2025-08-12.- REST API: Timing Security
- WebSocket API: Timing Security
2025-09-12
- The QuickFix schema for FIX Order Entry has been updated to support Pegged Orders.
- Updated FIX API Documentation for
RecvWindow
in
2025-08-28
- Updated SBE FAQ section regarding legacy support to include more details on schema compatibility and explain
NonRepresentable
andNonRepresentableMessage
.
2025-08-26
- Updated "Request Security" documentation for REST API and WebSocket API with no functional changes.
2025-08-25
- SBE: schema 3:1 (spot_3_1.xml) will be updated on 2025-08-25 at 05:00 UTC
- The following fields have been renamed because the SbeTool code generator has been found to generate Java code that does not compile.
- Although only users impacted by this issue need to update the schema, we advise all users to upgrade to the latest version to maintain consistency.
- Message
MaxAssetFilter
- field
limitExponent
renamed toqtyExponent
- field
limit
renamed tomaxQty
- field
- The following fields have been renamed because the SbeTool code generator has been found to generate Java code that does not compile.
2025-08-19
userDataStream.subscribe
returnssubscriptionId
in the responses.
This was missed in the previous changelog entry.
2025-08-12
Notice: The changes in this section will be gradually rolled out, and will take approximately up to two weeks to complete.
General Changes
- New error codes
-1120
and1211
. See Errors for more information. - The following requests have a new structure called
specialCommission
. See Commission Rates.- REST API
GET /api/v3/account/commission
POST /api/v3/order/test
withcomputeCommissionRates=true
POST /api/v3/sor/order/test
withcomputeCommissionRates=true
- WebSocket API
account.commission
order.test
withcomputeCommissionRates=true
sor.order.test
withcomputeCommissionRates=true
- REST API
- SBE: A new schema 3:1 (spot_3_1.xml) is available.
- The current schema 3:0 (spot_3_0.xml) is deprecated and will retire in 6 months as per our schema deprecation policy.
- Changes in schema 3:1:
ExchangeInfoResponse
: new fieldpegInstructionsAllowed
ExecutionReportEvent
: new fieldspricePeg
,pricePegOffsetLevel
,peggedPrice
UserDataStreamSubscribeResponse
: new fieldsubscriptionId
- New field
subscriptionId
for all user data stream events. - Field
apiKey
renamed tologgedOnApiKey
forWebSocketSessionLogonResponse
,WebSocketSessionStatusResponse
andWebSocketSessionLogoutResponse
OrderTestWithCommissionsResponse
: 2 new fieldsspecialCommissionForOrderMaker
andspecialCommissionForOrderTaker
AccountCommissionResponse
: 4 new fieldsspecialCommissionMaker
,specialCommissionTaker
,specialCommissionBuyer
andspecialCommissionSeller
- Support for
EXCHANGE_MAX_NUM_ORDER_LISTS
,MAX_NUM_ORDER_LISTS
, andMAX_NUM_ORDER_AMENDS
filters. ExecutionReportEvent
: fieldsrejectReason
andorigClientOrderId
now show their default values in SBE format to match the JSON format.NonRepresentableMessage
: New message added to represent a message that cannot be represented in this schema ID and version. Receipt of this message indicates that something should be available, but it is not representable using the SBE schema currently in use.
- Orders with cumulative quantity of 0 in the final state
EXPIRED_IN_MATCH
(i.e., the order expired due to STP) will be archived after 90 days. - Query order lists requests will first query the data in the cache, and if it cannot be found, will query the database.
- REST API:
GET /api/v3/openOrderLists
- WebSocket API:
openOrderLists.status
- REST API:
WebSocket API
- A single WebSocket connection can subscribe to multiple User Data Streams at once.
- Only one subscription per account is allowed on a single connection.
- Method
userDataStream.subscribe.signature
has been added that allows you to subscribe to the User Data Stream without needing to login first.- This also doesn’t require an Ed25519 API Key, and can work with any API Key type.
- For SBE support, you need to use at least schema 3:1.
- Method
session.subscriptions
has been added to list all active subscriptions for the current session. - The meaning of the field
userDataStream
in the session requests has changed slightly.- Previously, this returned
true
if you were subscribed to the user data stream of your logged-on account. - Now returns
true
if you have at least one active user data stream subscription, otherwisefalse
.
- Previously, this returned
userDataStream.unsubscribe
supports closing multiple subscriptions.- When called with no parameter, this will close all subscriptions.
- When called with
subscriptionId
, this will attempt to close the subscription matching that Id, if it exists. - The authorization for this request has been changed to
NONE
.
- Field
subscriptionId
has been added to the User Data Stream events payload when listening through the WebSocket API. This will identify which subscription the event is coming from.
FIX API
- When a client sends a reject message, the FIX API will no longer send the client back a Reject
<3>
message. - Error messages are now clearer when a tag is invalid, missing a value, or when the field value is empty or malformed.
-
{"code": -1169, "msg": "Invalid tag number."}
-
{"code": -1177, "msg": "Tag specified without a value."}
-
{"code": -1102, "msg": "Field value was empty or malformed."}
-
Future Changes
The following changes will be available on 2025-08-27 starting at 07:00 UTC:
- Exchange Information requests will emit a new field,
pegInstructionsAllowed
. - Bug fix: The Matching Engine will no longer accept order lists that exceed the order count filter limits. Affected filters:
MAX_NUM_ORDERS
MAX_ALGO_ORDERS
MAX_ICEBERG_ORDERS
EXCHANGE_MAX_NUM_ORDERS
EXCHANGE_MAX_ALGO_ORDERS
EXCHANGE_MAX_ICEBERG_ORDERS
The following changes will be available on 2025-08-28 starting at 07:00 UTC:
- The pegged orders functionality will be available.
pegInstructionsAllowed
will be set totrue
for all symbols, enabling the use of pegged orders for all APIs.- The following conditional fields
pegPriceType
,pegOffSetType
,pegOffsetValues
, andpeggedPrice
will appear in responses of the following requests if the order is a pegged order:- REST API
GET /api/v3/order
GET /api/v3/orderList
GET /api/v3/openOrderList
GET /api/v3/allOrders
DELETE /api/v3/order
DELETE /api/v3/orderList
DELETE /api/v3/openOrders
PUT /api/v3/order/amend/keepPriority
- WebSocket API
order.status
orderList.status
allOrders
order.cancel
orderList.cancel
openOrders.cancelAll
order.amend.keepPriority
- REST API
- FIX API
OrdType(40)
supports new valueP(PEGGED)
- Tags
PegOffsetValue(211)
,PegPriceType(1094)
,PegMoveType(835)
, andPegOffsetType(836)
have been added to the following messages:- NewOrderSingle
<D>
- NewOrderList
<E>
- OrderCancelRequestAndNewOrderSingle
<XCN>
- NewOrderSingle
- When placing an order, the
ExecutionReport
<8>
message will echo backPegInstructions
, with an extra optional fieldPeggedPrice (839)
.
- New error messages for pegged orders are added. Please see the Errors document for more information.
- Changes with
recvWindow
will be enabled.- A third check is performed after your message leaves our message broker, just before it is sent to the Matching Engine.
- This does not cover potential delays inside the Matching Engine itself.
recvWindow
supports microseconds.- The value is still specified in milliseconds, but it can now include a decimal component for higher precision.
- This means the parameter can now support up to three decimal places (e.g., 6000.346).
- APIs affected:
- FIX API
- REST API
- WebSocket API
- A third check is performed after your message leaves our message broker, just before it is sent to the Matching Engine.
- New
MAX_NUM_ORDER_LISTS
filter will be enabled, limiting the number of order lists to 20 per symbol. - New
MAX_NUM_ORDER_AMENDS
filter will be enabled, limiting each order to a maximum of 10 amendments.
2025-08-07
- Updated FIX API documentation
- FIX Market Data limits: The subscription limit has always been present but was undocumented.
- On message processing order: Reworded and reformatted.
2025-07-03
- Beginning at 2025-07-08 07:00 UTC, WebSocket Streams will be upgraded.
- During the upgrade, existing and new connections may be disconnected in less than 24 hours.
- The upgrade may take up to 2 hours; We apologize for the inconvenience.
2025-06-04
REST and WebSocket API:
- Reminder that SBE 2:0 schema will be retired on 2025-06-12, 6 months after being deprecated.
- The SBE lifecycle for Production has been updated to reflect this change.
2025-05-28
- Documented API timeout value and error under General API Information for each API:
2025-05-22
Notice: The following changes will happen at 2025-06-06 7:00 UTC.
- The previous behavior of
recvWindow
on FIX, REST, and WebSocket APIs will be augmented by an additional check.- To review, the existing behavior is:
- If
timestamp
is greater thanserverTime
+ 1 second at receipt of the request, the request is rejected. Rejection by this check increments message limits (FIX API) and IP limits (REST and WebSocket APIs), but not Unfilled Order Count (order placement endpoints of all APIs). - If the difference between
timestamp
andserverTime
at receipt of the request is greater thanrecvWindow
, the request is rejected. Rejection by this check increments message limits (FIX API) and IP limits (REST and WebSocket APIs) but not Unfilled Order Count (order placement endpoints of all APIs).
- If
- The additional check is:
- Just before a request is forwarded to the Matching Engine, if the difference between
timestamp
and the currentserverTime
is greater thanrecvWindow
, the request is rejected. Rejection by this check increments message limits (FIX API), IP limits (REST and WebSocket APIs), and Unfilled Order Count (order placement endpoints of all APIs).
- Just before a request is forwarded to the Matching Engine, if the difference between
- The documentation for Timing security has been updated to reflect the additional check.
- To review, the existing behavior is:
- Fixed a bug in FIX Market Data message InstrumentList
<y>
. Previously, the value ofNoRelatedSym(146)
could have been incorrect.
2025-04-29
- Features that currently require an Ed25519 API key will soon be opened up to HMAC and RSA keys.
- For example, subscribing to User Data Stream in WebSocket API will be possible with any API key type before listenKeys are removed.
- Users are still encouraged to migrate to Ed25519 API keys as they are more secure and performant on Binance Spot Trading.
- More details to come.
2025-04-25
- The following request weights have been increased from 1 to 4:
- REST API:
PUT /api/v3/order/amend/keepPriority
- WebSocket API:
order.amend.keepPriority
- The documentation for both REST and WebSocket API has been updated to reflect these changes.
- REST API:
- Clarified that
SEQNUM
in the FIX-API is a 32-bit unsigned integer that rolls over. This has been theSEQNUM
data type since the inception of the FIX-API.
2025-04-21
Clarification on the release of Order Amend Keep Priority and STP Decrement:
- At 2025-05-07 07:00 UTC
- Order Amend Keep Priority will be enabled on all symbols.
- STP Decrement will be allowed on all symbols.
- At 2025-04-24, 07:00 UTC, the field
amendAllowed
will become visible on Exchange Information requests, but the feature will not be enabled yet. - SPOT Testnet has both features enabled/allowed on all symbols.
2025-04-08
Notice: The changes in this section will be gradually rolled out, and will take a week to complete.
- New Error code
-2039
where if querying an order with bothorderId
andorigClientOrderId
and no order is found with this combination.- Affected requests:
- REST API:
GET /api/v3/order
- WebSocket API:
order.status
- REST API:
- Affected requests:
- The Errors Documentation has also been updated with the new error messages for code
-1034
when the FIX connection rate limits have exceeded. (More details can be found in yesterday's update)
2025-04-07
General Changes
Notice: The changes in this section will be gradually rolled out, and will take a week to complete.
- FIX Market Data connection limits were increased from 5 to 100 on January 16, 2025. This was not previously highlighted in changelog.
- New Error code
-2038
for order amend keep priority requests that fail. - New messages for error code
-1034
. - If the unfilled order count for
intervalNum:DAY
is exceeded, the unfilled order count forintervalNum:SECOND
is no longer incremented. - Previously, the request weight for myTrades was 20 regardless of the parameters provided. Now, if you provide
orderId
, the request weight is 5.- REST API:
GET /api/v3/myTrades
- WebSocket API:
myTrades
- REST API:
- Change when querying and deleting orders:
- When neither
orderId
nororigClientOrderId
are present, the request is now rejected with-1102
instead of-1128
. - Affected requests:
- REST API:
GET /api/v3/order
DELETE /api/v3/order
- WebSocket API
order.status
order.cancel
- FIX API
- OrderCancelRequest
<F>
- OrderCancelRequest
- REST API:
- When neither
FIX API
Notice: The following changes will occur during April 21, 2025.
- FIX API verifies that
EncryptMethod(98)
is 0 at Logon<A>
. - FIX Order Entry connection limits will be a maximum of 10 concurrent connections per account.
- The connection rate limits are now enforced. Note that these limits are checked independently for both the account and the IP address.
- FIX Order Entry: 15 connection attempts within 30 seconds
- FIX Drop Copy: 15 connection attempts within 30 seconds
- FIX Market Data: 300 connection attempts within 300 seconds
- News
<B>
contains a countdown until disconnection in the Headline field.- Following the completion of this update, when the server enters maintenance, a
News
message will be sent to clients every 10 seconds for 10 minutes. After this period, clients will be logged out and their sessions will be closed.
- Following the completion of this update, when the server enters maintenance, a
- OrderCancelRequest
<F>
and OrderCancelRequestAndNewOrderSingle<XCN>
now allow bothorderId
andclientOrderId
. - The QuickFix schema for FIX OE is updated to support the Order Amend Keep Priority feature and new STP mode,
DECREMENT
.
User Data Streams
- Receiving user data streams on wss://stream.binance.com:9443 using a
listenKey
is now deprecated.- This feature will be removed from our systems at a later date.
- Instead, you should get user data updates by subscribing to the User Data Stream on the WebSocket API.
- This should offer slightly better performance (lower latency).
- This requires the use of an Ed25519 API Key.
- In a future update, information about the base WebSocket endpoint for the User Data Streams will be removed.
- In a future update, the following requests will be removed from the documentation:
POST /api/v3/userDataStream
PUT /api/v3/userDataStream
DELETE /api/v3/userDataStream
userDataStream.start
userDataStream.ping
userDataStream.stop
- The User Data Stream documentation will remain as reference for the payloads you can receive.
Future Changes
The following changes will occur at April 24, 2025, 07:00 UTC:
Order Amend Keep Priority becomes available. (Note that the symbol has to have the feature enabled to be used.)- UPDATE 2025-04-21: The exact date "Order Amend Keep Priority" will be enabled has not yet been determined.
- New field
amendAllowed
becomes visible in Exchange Information responses.- REST API:
GET /api/v3/exchangeInfo
- WebSocket API:
exchangeInfo
- REST API:
- FIX API: New Order Entry Messages OrderAmendKeepPriorityRequest and OrderAmendReject
- REST API:
PUT /api/v3/order/amend/keepPriority
- WebSocket API:
order.amend.keepPriority
STP modeDECREMENT
becomes visible in Exchange Information if the symbol has it configured.- UPDATE 2025-04-21: The exact date
DECREMENT
STP will be enabled has not yet been determined. - Instead of expiring only the maker, only the taker, or unconditionally both orders, STP decrement decreases the available quantity of both orders and increases the
prevented quantity
of both orders by the amount of the prevented match. - This expires the order with less available quantity as (
filled quantity
+prevented quantity
) equalsorder quantity
. Both orders expire if their available quantities are equal. It is called a "decrement" because it reduces available quantity.
- UPDATE 2025-04-21: The exact date
- Behavior when querying and/or canceling with
orderId
andorigClientOrderId/cancelOrigClientOrderId
:- The behavior when both parameters were provided was not consistent across all endpoints.
- Moving forward, when both parameters are provided, the order is first searched for using its
orderId
, and if found,origClientOrderId
/cancelOrigClientOrderId
is checked against that order. If both conditions pass, the request succeeds. If both conditions are not met the request is rejected. - Affected requests:
- REST API:
GET /api/v3/order
DELETE /api/v3/order
POST /api/v3/order/cancelReplace
- WebSocket API:
order.status
order.cancel
order.cancelReplace
- FIX API
- OrderCancelRequest
<F>
- OrderCancelRequestAndNewOrderSingle
<XCN>
- OrderCancelRequest
- REST API:
- Behavior when canceling with
listOrderId
andlistClientOrderId
:- The behavior when both parameters were provided was not consistent across all endpoints.
- Moving forward, when both parameters are passed, the order list is first searched for using its
listOrderId
, and if found,listClientOrderId
is checked against that order list. If both conditions are not met the request is rejected. - Affected requests:
- REST API
DELETE /api/v3/orderList
- WebSocket API
orderList.cancel
- REST API
- SBE: A new schema 3:0 (spot_3_0.xml) is now available.
- The current schema 2:1 (spot_2_1.xml) is now deprecated and will be retired in 6 months as per our schema deprecation policy.
- Note that trying to use schema 3:0 before it is released will result in an error.
- Changes in schema 3:0:
- Support for Order Amend Keep Priority:
- Added field
amendAllowed
to ExchangeInfoResponse. - New Messages
OrderAmendmentsResponse
andOrderAmendKeepPriorityResponse
- Added field
- All enums now have a
NON_REPRESENTABLE
variant. This will be used to encode new enum values in the future, which would be incompatible with 3:0. - New enum variant
DECREMENT
forselfTradePreventionMode
andallowedSelfTradePreventionModes
symbolStatus
enum valuesAUCTION_MATCH
,PRE_TRADING
andPOST_TRADING
have been removed.- Fields
usedSor
,orderCapacity
,workingFloor
,preventedQuantity
, andmatchType
are no longer optional. - Field
orderCreationTime
inExecutionReportEvent
is now optional.
- Support for Order Amend Keep Priority:
- When using deprecated schema 2:1 on the WebSocket API to listen to the User Data Stream:
ListStatusEvent
fieldlistStatusType
will be rendered asExecStarted
when it should have beenUpdated
. Upgrade to schema 3:0 to get the correct value.ExecutionReportEvent
fieldselfTradePreventionMode
will be rendered asNone
when it should have beenDecrement
. This only happens whenexecutionType
isTradePrevention
.ExecutionReportEvent
fieldorderCreationTime
will be rendered as -1 when it has no value.
- All schemas below 3:0 are unable to represent responses for Order Amend Keep Priority requests and any response that could contain the STP mode
DECREMENT
(e.g. Exchange Information, order placement, order cancelation, or querying the status of your order). When a response cannot be represented in the requested schema, an error is returned.
2025-04-03
- Following SPOT Testnet's latest announcement, updating the URL in the WebSocket API to the latest URL for SPOT Testnet.
2025-03-31
- Added a clarification on the performance of canceling an order.
2025-03-10
- Notice: The following changes will happen on 2025-03-13 09:00 UTC
- FIX Drop Copy sessions will have a limit of 60 messages per minute.
- FIX Market Data sessions will have a limit of 2000 messages per minute.
- The FIX API documentation has been updated to reflect the upcoming changes.
- SBE Market Data Streams will be available on March 18 2025, 07:00 UTC. These streams offer a smaller payload and should offer better latency than the equivalent JSON streams for a subset of latency-sensitive market data streams.
- Streams available in SBE format:
- Real-time: trade stream
- Real-time: best bid/ask
- Every 100 ms: diff. depth
- Every 100 ms: partial book depth
- For more information please refer to the SBE Market Data Streams.
- Streams available in SBE format:
2025-03-05
- Notice: The following changes will happen on March 10, 2025 12:00 UTC.
The following request weights will be increased from 2 to 4:- REST API:
GET /api/v3/aggTrade
- WebSocket API:
trades.aggregate
- REST API:
- The documentation for both REST and WebSocket API has been updated to reflect the upcoming changes.
2025-02-12
- Notice: These changes will take effect on February 26, 2025 05:00 UTC. Please ensure you have downloaded the latest schema before then.
AggressorSide (2446)
will be rendered in the FIX Market Data Trade Stream. The QuickFix schema file has also been updated.
2025-01-28
- Notice: These changes will be gradually rolled out between February 3, 2025 and February 14, 2025.
The following changes will apply to WebSocket Market Data Streams, User Data Streams, and the WebSocket API:
- Our WebSocket services will send a ping frame every 20 seconds instead of 3 minutes.
- The allowed pong delay will be every 1 minute instead of 10 minutes.
- The documentation for these services have been updated to reflect the change.
2025-01-09
- FIX Market Data will be available at January 16, 05:00 UTC. The FIX API documentation has been updated regarding this feature.
- Please refer to this link for the QuickFIX Schema for FIX Market Data.
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.
- For example:
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.
- Supported values:
- 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.
- Supported values:
- 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
- Supported values
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/orendTime
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 withnewOrderRespType
set toRESULT
orFULL
.- Please refer to the table below for affected requests with:
origQuoteOrderQty
:
- Please refer to the table below for affected requests with:
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
- New field
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
, andsession.logout
- Added a new field
userDataStream
indicating if the user data stream subscription is active.
- Added a new field
- Fixed a bug where you wouldn't receive a new listenKey using
userDataStream.start
aftersession.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 astopPrice
. TAKE_PROFIT
andTAKE_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.
- Previously OCOs could only be composed by the following order types:
2024-10-18
REST and WebSocket API:
- Reminder that SBE 1:0 schema will be disabled on 2024-10-25, 6 months after being deprecated, as per our SBE policy.
- The SBE lifecycle for Prod has been updated to reflect this change.
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 frompermissionsSets
; 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
- Spot Unfilled Order Count Rules have been updated to explain how to decrease your unfilled order count when placing orders.
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
- FIX API and Drop Copy Sessions will be available on August 8, 05:00 UTC.
2024-07-26
- FIX API and Drop Copy Sessions has been added to the documentation.
- The release date to the live exchange has not been determined.
2024-07-22
General changes:
- Fixed a bug where klines had incorrect timestamps.
- REST API:
GET /api/v3/klines
andGET /api/v3/uiKlines
withtimeZone
parameter - WebSocket API:
klines
anduiKlines
withtimeZone
parameter - WebSocket Streams:
<symbol>@kline_<interval>@+08:00
streams
- REST API:
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
- REST API:
- New requests have been added:
- On June 18, 05:00 UTC, Buyer order ID
b
and Seller order IDa
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.)- WebSocket Streams has been updated regarding this change.
- To monitor if your order was part of a trade, please listen to the User Data Streams
2024-06-06
This will be available by June 6, 11:59 UTC.
REST API
orderRateLimitExceededMode
has been added toPOST /api/v3/order/cancelReplace
.
WebSocket API
orderRateLimitExceededMode
has been added toorder.cancelReplace
.