Change Log
2024-11-04
USDⓈ-M Futures & COIN-M Futures
GET /fapi/v1/pmExchangeInfo
andGET /dapi/v1/pmExchangeInfo
will be deprecated on 2024-11-15
2024-11-01
Options
- Add block trade endpoints:
POST eapi/v1/block/order/create
PUT eapi/v1/block/order/create
DELETE eapi/v1/block/order/create
GET eapi/v1/block/order/orders
POST eapi/v1/block/order/execute
GET eapi/v1/block/order/execute
GET eapi/v1/block/user-trades
2024-10-29
Portfolio Margin Pro
- The following REST endpoints will be adjusted:
POST /sapi/v1/portfolio/repay-futures-switch
: Effective on 2024-11-01, rate limit will be adjusted to 20/day.
Portfolio Margin
- The following REST endpoints will be adjusted:
POST /papi/v1/repay-futures-switch
: Effective on 2024-11-01, rate limit will be adjusted to 20/day.
2024-10-24
Options
- API Field Removal(Effective 2024-10-28):
- In the
GET /eapi/v1/exchangeInfo
endpoint, theid
field will be removed fromoptionContracts
, theid
field will been removed fromoptionAssets
, and both thecontractId
andid
fields have been removed fromoptionSymbols
. - The
id
andcid
fields will been removed from theoption_pair
websocket stream
- In the
2024-10-21
USDⓈ-M Futures & COIN-M Futures
- Effective from 2024-10-30 00:00 (UTC), the endpoints will only support querying futures trade histories within the most recent 6 months:
GET /fapi/v1/userTrades
GET /dapi/v1/userTrades
COIN-M Futures
- Add new historical data download endpoint:
GET /dapi/v1/order/asyn
: to get Download Id For Futures Order HistoryGET /dapi/v1/order/asyn/id
: to get Futures Order History Download Link by IdGET /dapi/v1/trade/asyn
: to get Download Id For Futures Trade HistoryGET /dapi/v1/trade/asyn/id
: to get Futures Trade History Download Link by Id
2024-10-15
Portfolio Margin Pro(Release date 2024-10-18)
- New endpoint to get Portfolio Margin Pro SPAN Account Info(For Portfolio Margin Pro SPAN users only):
GET /sapi/v2/portfolio/account
- New endpoint to get Portfolio Margin Pro Account Balance Info:
GET /sapi/v1/portfolio/balance
Portfolio Margin
- New endpoint to get download id for UM futures trade history:
GET /papi/v1/um/trade/asyn
- New endpoint to get UM futures trade download link by Id:
GET /papi/v1/um/trade/asyn/id
- New endpoint to get download id for UM futures order history:
GET /papi/v1/um/order/asyn
- New endpoint to get UM futures order download link by Id:
GET /papi/v1/um/order/asyn/id
- New endpoint to get download id for UM futures transaction history:
GET /papi/v1/um/income/asyn
- New endpoint to get UM futures transaction download link by Id:
GET /papi/v1/um/income/asyn/id
2024-10-14
USDⓈ-M Futures
- The following REST endpoints will be adjusted:
POST /fapi/v1/convert/getQuote
: Effective on 2024-10-19, rate limit will be adjusted to 360/hour, 500/day.POST /fapi/v1/convert/getQuote
:validTime
can only be set to10s
2024-10-11
COIN-M Futures
-
Self-Trade Prevention:
-
Self-Trade Prevention (aka STP) is added to the system. This prevents orders from matching with orders from the same account, or accounts under the same
tradeGroupId
(currently only support same account). For more detail, please check FAQ -
User can set
selfTradePreventionMode
when placing new orders. All symbols support the following STP mode:- NONE: No Self-Trade Prevention
- EXPIRE_TAKER: expire taker order when STP trigger
- EXPIRE_BOTH: expire taker and maker order when STP trigger
- EXPIRE_MAKER: expire maker order when STP trigger
-
REST Update:
- New order status
EXPIRED_IN_MATCH
- This means that the order expired due to STP being triggered. - Add optional parameter
selfTradePreventionMode
in the endpoints below to set order's STP mode:POST /dapi/v1/order
POST /dapi/v1/batchOrders
- Add new field
selfTradePreventionMode
in response of the endpoints below to show order's STP mode:POST /dapi/v1/order
POST /dapi/v1/batchOrders
GET /dapi/v1/order
GET /dapi/v1/openOrders
GET /dapi/v1/allOrders
PUT /dapi/v1/order
PUT /dapi/v1/batchOrders
DELETE /dapi/v1/order
DELETE /dapi/v1/batchOrders
- New order status
-
WEBSOCKET User Data Stream:
- Add new field
V
inORDER_TRADE_UPDATE
to order STP mode.
- Add new field
-
Price Match
-
Coin margin future supports order price match function. This feature allows users' LIMIT/STOP/TAKE_PROFIT orders to be placed without entering a price. The price match function will automatically determine the order price in real-time based on the price match mode and the order book.
-
The following priceMatch modes are supported on order level:
- NONE: no price match
- OPPONENT: counterparty best price
- OPPONENT_5: counterparty 5th best price
- OPPONENT_10: counterparty 10th best price
- OPPONENT_20: counterparty 20th best price
- QUEUE: the best price on the same side of the order book
- QUEUE_5: the 5th best price on the same side of the order book
- QUEUE_10: the 10th best price on the same side of the order book
- QUEUE_20: the 20th best price on the same side of the order book
-
Example:
- User places buy order and set priceMatch as QUEUE_5, the order price will be 5th best bid price of the orderbook
- User places buy order and set priceMatch as OPPONENT, the order price will be best ask price of the orderbook
-
REST Update:
-
Add optional parameter priceMatch in the endpoints below to set order's priceMatch mode:
POST /dapi/v1/order
POST /dapi/v1/batchOrders
-
Add new field priceMatch in response of the endpoints below to show order's priceMatch mode:
POST /dapi/v1/order
POST /dapi/v1/batchOrders
GET /dapi/v1/order
GET /dapi/v1/openOrders
GET /dapi/v1/allOrders
PUT /dapi/v1/order
PUT /dapi/v1/batchOrders
DELETE /dapi/v1/order
DELETE /dapi/v1/batchOrders
-
WEBSOCKET User Data Stream:
- Add new field
pm
inORDER_TRADE_UPDATE
to show price match mode.
- Add new field
2024-10-10
USDⓈ-M Futures
-
Binance will update the following endpoints, estimated to be in force on 2024-10-17 03:00 (UTC). After 2024-10-17 03:00 (UTC), the endpoints will support querying futures trade histories that are not older than one year:
GET /fapi/v1/aggTrades
GET /dapi/v1/aggTrades
-
Binance will update the following endpoints, estimated to be in force on 2024-10-16 03:00 (UTC). After 2024-10-16 03:00 (UTC), the endpoint will support querying future histories that are not older than 30 days:
GET /fapi/v1/positionMargin/history
2024-10-08
COIN-M Futures
-
The most recent 7-days data is returned by default when requesting the following endpoints. The query time period for these endpoints must be less than 7 days:
GET /dapi/v1/allOrders
GET /dapi/v1/userTrades
-
The following endpoints will be adjusted to keep only recent three month data:
GET /dapi/v1/order
GET /dapi/v1/allOrders
2024-09-27
USDⓈ-M Futures
- The following websocket user data requests are deprecated:
listenkey@account
listenkey@balance
listenkey@position
COIN-M Futures
- The following websocket user data requests are deprecated:
listenkey@account
listenkey@balance
listenkey@position
2024-09-19
Portfolio Margin
- New endpoint to repay debt for Margin:
POST /papi/v1/margin/repay-debt
: Repay debt for a margin loan.
2024-09-06
Portfolio Margin
-
Update endpoint for Portfolio Margin/Trade(Release date 2024-09-06):
POST /papi/v1/um/order
: add parameterpriceMatch
to support priceMatch for place orderPOST/papi/v1/um/conditional/order
: add parameterpriceMatch
to support priceMatch for plac conditional orderPUT /papi/v1/um/order
: add parameterpriceMatch
to ssupport priceMatch for order modification
-
Add new field
priceMatch
in response of the endpoints below to show order's priceMatch:POST /papi/v1/um/order
POST/papi/v1/um/conditional/order
PUT /papi/v1/um/order
GET /papi/v1/um/orderAmendment
GET /papi/v1/um/order
GET /papi/v1/um/openOrder
GET /papi/v1/um/openOrders
GET /papi/v1/um/allOrders
GET /papi/v1/um/conditional/openOrder
GET /papi/v1/um/conditional/openOrders
GET /papi/v1/um/conditional/orderHistory
GET /papi/v1/um/conditional/allOrders
DELETE /papi/v1/um/order
DELETE /papi/v1/um/conditional/order
-
WEBSOCKET
- Add new field
pm
inORDER_TRADE_UPDATE
andCONDITIONAL_ORDER_TRADE_UPDATE
, which represents priceMatch .
- Add new field
2024-09-05
Portfolio Margin Pro
- New endpoint to query Portfolio Margin Pro Tiered Collateral Rate:
GET /sapi/v2/portfolio/collateralRate
: Query Portfolio Margin Pro Tiered Collateral Rate.
2024-09-03
USDⓈ-M Futures
- User data stream will add
TRADE_LITE
event.TRADE_LITE
event designed to reduce user data latency by focusing solely on ‘TRADE’ execution type and minimizing the number of user data fields, providing a faster and more efficient experience compared to the originalORDER_TRADE_UPDATE
user data stream.
2024-08-26
USDⓈ-M Futures
- New endpoint to Future Convert:
GET /fapi/v1/convert/exchangeInfo
POST /fapi/v1/convert/getQuote
POST /fapi/v1/convert/acceptQuote
GET /fapi/v1/convert/orderStatus
2024-08-23
Portfolio Margin
- New endpoint to toggle UM Futures BNB Burn:
POST /papi/v1/um/feeBurn
: Toggle BNB Burn on UM Futures Trade.GET /papi/v1/um/feeBurn
: Get UM Futures BNB Burn status.
- New Endpoints to Query Account Information:
GET /papi/v1/um/accountConfig
: Query user UM account configuration.GET /papi/v1/um/symbolConfig
: Query user symbol configuration.GET /papi/v2/um/account
: Compared toGET /papi/v1/um/account
, this endpoint only returns symbols that the user has positions or open orders in. Configuration-related fields have been removed and can now be queried fromGET /papi/v1/um/symbolConfig
andGET /papi/v1/um/accountConfig
. The V2 endpoint also offers better performance.
2024-08-07
USDⓈ-M Futures
-
The following endpoints IP weight limit will be adjusted from 2024-09-03:
- REST API:
GET /fapi/v2/balance
: 5->10GET /fapi/v2/account
: 5->10GET /fapi/v2/positionRisk
: 5->10
- Websocket API:
account.status
: 5->10account.balance
: 5->10account.position
: 5->10
- REST API:
-
The following WebSocket User Data Requests will be deprecated from 2024-09-03
- <listenKey>@account
- <listenKey>@balance
- <listenKey>@position
Please refer to annoucement for api replacement
2024-08-06
COIN-M Futures
GET /dapi/v1/pmExchangeInfo
will be deprecated on August 6,2024 due to removing notionalLimit
restriction.
2024-07-24
USDⓈ-M Futures
REST API
-
New Endpoints to Query Account Information:
GET /fapi/v1/symbolConfig
: Query user symbol configuration.GET /fapi/v1/accountConfig
: Query user account configuration.GET /fapi/v3/account
: Compared toGET /fapi/v2/account
, this endpoint only returns symbols that the user has positions or open orders in. Configuration-related fields have been removed and can now be queried fromGET /fapi/v1/symbolConfig
andGET /fapi/v1/accountConfig
. The V3 endpoint also offers better performance.GET /fapi/v3/balance
: Query user account balance.
-
New Endpoints to Query Trade Information:
GET /fapi/v3/positionRisk
: Compared toGET /fapi/v2/positionRisk
, this endpoint only returns symbols that the user has positions or open orders in. Configuration-related fields have been removed and can now be queried fromGET /fapi/v1/symbolConfig
. The V3 endpoint also offers better performance.
WebSocket API
- New Endpoints to Query Account Information:
v2/account.status
: Compared toaccount.status
, this endpoint only returns symbols that the user has positions or open orders in. Configuration-related fields have been removed and can now be queried fromGET /fapi/v1/symbolConfig
andGET /fapi/v1/accountConfig
. The V2 endpoint also offers better performance.v2/account.balance
: Query user account balance.v2/account.position
: Compared toaccount.position
, this endpoint only returns symbols that the user has positions or open orders in. Configuration-related fields have been removed and can now be queried fromGET /fapi/v1/symbolConfig
. The V2 endpoint also offers better performance.
Deprecation Notice:
- The following endpoints will be deprecated in the coming months (exact date to be announced later). Please switch to the new endpoints listed above:
- REST API:
GET /fapi/v2/balance
GET /fapi/v2/account
GET /fapi/v2/positionRisk
- Websocket API:
account.status
account.balance
account.position
- REST API:
2024-07-17
Portfolio Margin
REST API
- The response field
marginAsset
inGET /papi/v1/um/userTrades
will be removed on 2024-07-17.
2024-06-19
USDⓈ-M Futures
REST API
- The response field
marginAsset
inGET /fapi/v1/userTrades
will be removed on 2024-06-25.
2024-05-22
USDⓈ-M Futures
REST API & Websocket API
- New endpoint to toggle BNB Burn:
POST /fapi/v1/feeBurn
to toggle BNB Burn on Futures Trade.GET /fapi/v1/feeBurn
to get BNB Burn status.
2024-04-19
USDⓈ-M Futures
REST API & Websocket API
- The new field listenKey will be integrated into the response received from the
PUT /fapi/v1/listenKey
endpoint and WebSocket apiuserDataStream.ping
. This enhancement will allow users to view the key that has been kept alive. This update is scheduled to take effect on 2024-04-25.
{
"listenKey": "3HBntNTepshgEdjIwSUIBgB9keLyOCg5qv3n6bYAtktG8ejcaW5HXz9Vx1JgIieg"
}
2024-04-09
USDⓈ-M Futures/ COIN-M Futures / Portfolio Margin
WEBSOCKET API
- Good-Till-Cancel (GTC) timeInForce will have a one-year validity period after order placement. GTC orders longer than one-year will be automatically canceled. This applies to all order types including reduceOnly but does not affect part-filled orders or strategy trading or copy-trading orders.
2024-04-01
USDⓈ-M Futures
WEBSOCKET API
- Websocket API is now available and can be accessed through this URL:
wss://ws-fapi.binance.com/ws-fapi/v1
- 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.
2024-03-11
USDⓈ-M Futures
REST
- Add new Account Endpoints:
GET /fapi/v1/rateLimit/order
: query user order rate limits
2024-02-09
USDⓈ-M Futures
Binance Future is doing Websocket Service upgrade and the upgrade impacts the following:
-
Before upgrade:
- The websocket server will send a ping frame every 3 minutes. If the websocket server does not receive a pong frame back from the connection within a 10 minute period, the connection will be disconnected. Unsolicited pong frames are allowed.
-
After upgrade:
- Websocket server will send a
ping frame
every 3 minutes.- If the websocket server does not receive a
pong frame
back from the connection within a 10 minute period, the connection will be disconnected. - When you receive a ping, you must send a pong with a copy of ping's payload as soon as possible.
- Unsolicited
pong frames
are allowed, but will not prevent disconnection. It is recommended that the payload for these pong frames are empty.
- If the websocket server does not receive a
- Websocket server will send a
2024-01-24
USDⓈ-M Futures
Testnet WEBSOCKET
- The Websocket baseurl for testnet is updated to "wss://fstream.binancefuture.com"
2024-01-19
Portfolio Margin
-
REST
- New endpoints
PUT /papi/v1/um/order
andPUT /papi/v1/cm/order
to support UM/CM limit order modify - New endpoints
GET /papi/v1/um/orderAmendment
andGET /papi/v1/cm/orderAmendment
to get UM/CM order modify history
- New endpoints
2024-01-11
Portfolio Margin
-
Self-Trade Prevention(Released):
-
Self-Trade Prevention (aka STP) will be added to the system. This will prevent orders from matching with orders from the same account, or accounts under the same
tradeGroupId
. For more detail, please check FAQ -
User can set
selfTradePreventionMode
when placing new orders. All symbols support the following STP mode:- NONE: No Self-Trade Prevention
- EXPIRE_TAKER: expire taker order when STP trigger
- EXPIRE_BOTH: expire taker and maker order when STP trigger
- EXPIRE_MAKER: expire maker order when STP trigger
-
REST Update:
-
New order status
EXPIRED_IN_MATCH
- This means that the order expired due to STP being triggered. -
GET /papi/v1/um/account: Add new field
tradeGroupId
in response to show user's tradeGroupId -
Add optional parameter
selfTradePreventionMode
in the endpoints below to set order's STP mode:- POST /papi/v1/um/order
- POST/papi/v1/um/conditional/order
- POST /papi/v1/margin/order
- POST /papi/v1/margin/order/oco
-
Add new field
selfTradePreventionMode
in response of the endpoints below to show order's STP mode:-
POST /papi/v1/um/order
-
POST/papi/v1/um/conditional/order
-
GET /papi/v1/um/order
-
GET /papi/v1/um/openOrder
-
GET /papi/v1/um/openOrders
-
GET /papi/v1/um/allOrders
-
GET /papi/v1/um/conditional/openOrder
-
GET /papi/v1/um/conditional/openOrders
-
GET /papi/v1/um/conditional/orderHistory
-
GET /papi/v1/um/conditional/allOrders
-
DELETE /papi/v1/um/order
-
DELETE /papi/v1/um/conditional/order
-
DELETE /papi/v1/margin/order
-
DELETE /papi/v1/margin/allOpenOrders
-
DELETE /papi/v1/margin/orderList
-
GET /papi/v1/margin/order
-
GET /papi/v1/margin/allOrders
-
GET /papi/v1/margin/orderList
-
GET /papi/v1/margin/allOrderList
-
GET /papi/v1/margin/openOrderList
-
-
-
WEBSOCKET User Data Stream:
- Add new field
V
inORDER_TRADE_UPDATE
andCONDITIONAL_ORDER_TRADE_UPDATE
to order STP mode. - 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
- Add new field
-
Good Till Date TIF(Released)
-
USDⓈ margin future will support Good To Date TIF. Orders with the TIF set to GTD will be automatically canceled by the
goodTillDate
time. -
REST Update:
-
Add optional parameter
goodTillDate
in the endpoints below to set order'sgoodTillDate
:- POST /papi/v1/um/order
- POST/papi/v1/um/conditional/order
-
Add new field
goodTillDate
in response of the endpoints below to show order'sgoodTillDate
:- POST /papi/v1/um/order
- POST/papi/v1/um/conditional/order
- GET /papi/v1/um/order
- GET /papi/v1/um/openOrder
- GET /papi/v1/um/openOrders
- GET /papi/v1/um/allOrders
- GET /papi/v1/um/conditional/openOrder
- GET /papi/v1/um/conditional/openOrders
- GET /papi/v1/um/conditional/orderHistory
- GET /papi/v1/um/conditional/allOrders
- DELETE /papi/v1/um/order
- DELETE /papi/v1/um/conditional/order
-
-
WEBSOCKET User Data Stream:
- Add new field
gtd
inORDER_TRADE_UPDATE
andCONDITIONAL_ORDER_TRADE_UPDATE
to order good till date.
- Add new field
-
Breakeven Price(Released)
-
REST Update
- Add new field
breakEvenPrice
in The following endpoint- GET /papi/v1/um/account
- GET /papi/v1/um/positionRisk
- GET /papi/v1/cm/account
- GET /papi/v1/cm/positionRisk
- Add new field
-
WEBSOCKET
- New field
bep
represents Break-Even Price in positionP
of payload to event: Balance and Position Update – "e": "ACCOUNT_UPDATE"
- New field
2024-01-08
USDⓈ-M Futures
REST
- Update endpoint for Account/Trade(Release date 2023-01-11):
PUT /fapi/v1/order
: add parameterpriceMatch
to support priceMatch for order modificationPUT /fapi/v1/batchOrders
: add parameterpriceMatch
to support priceMatch for order modification- Order modification will preserve the original
selfTradePreventionMode
of the order
2023-12-12
USDⓈ-M Futures
WEBSOCKET
- Update speed for stream
!bookTicker
will be modified from real-time to every 5 seconds on starting December 20, 2023. Individual Symbol Book Ticker Streams<symbol>@bookticker
will remain unaffected by this update
2023-11-15
USDⓈ-M Futures
REST
- Add new Market Data Endpoints:
GET /fapi/v2/ticker/price
: this is v2 endpoint for querying latest price. It has same parameters and response as theGET /fapi/v1/ticker/price
, and it offers lower latency and consume less of the IP rate limit. Please note that theGET /fapi/v1/ticker/price
will be deprecated in the future, with the exact timing to be determined.
WEBSOCKET
- Binance Futures will retire the
wss://fstream-auth.binance.com
domain at 2023-12-15 06:00. API users are advised to establish a new WebSocket connection towss://fstream.binance.com
. Please note that the connection method forwss://fstream.binance.com
is different from that ofwss://fstream-auth.binance.com
. For instance:wss://fstream-auth.binance.com/ws/<ListenKey>?listenKey=<ListenKey>
should change towss://fstream.binance.com/ws/<ListenKey>
2023-11-01
COIN-M Futures
REST
- Update on
GET dapi/v1/fundingRate
:- add response field
markPrice
to display mark price associated with a particular funding fee charge
- add response field
2023-11-01
USDⓈ-M Futures
REST
-
Add new Market Data Endpoints:
GET /futures/data/basis
: query basis data
-
Update on
GET /fapi/v1/fundingRate
:- add response field
markPrice
to display mark price associated with a particular funding fee charge
- add response field
2023-10-19
COIN-M Futures
REST
- New Market Data Endpoints
GET /futures/data/delivery-price
: query quarterly contract settlement price
- Update Rate Limit to 1000/5min/IP on Market Data Endpoints below:
GET /futures/data/openInterestHist
GET /futures/data/topLongShortAccountRatio
GET /futures/data/topLongShortPositionRatio
GET /futures/data/globalLongShortAccountRatio
GET /futures/data/takerlongshortRatio
2023-10-19
European Options
Binance Option is doing Websocket Service upgrade and the upgrade impacts the following:
-
Before upgrade:
- The websocket server will send a ping frame every 5 minutes. If the websocket server does not receive a pong frame back from the connection within a 15 minute period, the connection will be disconnected. Unsolicited pong frames are allowed.
- To connect websocket server without subscription, user can connect by using
wss://nbstream.binance.com/eoptions/ws
wss://nbstream.binance.com/eoptions/stream
wss://nbstream.binance.com/eoptions/ws/
wss://nbstream.binance.com/eoptions/stream/
-
After upgrade:
- The websocket server will send a ping frame every 3 minutes. If the websocket server does not receive a pong frame back from the connection within a 10 minute period, the connection will be disconnected. Unsolicited pong frames are allowed.
- To connect websocket server without subscription:
- Connect websocket server with subscription:
wss://nbstream.binance.com/eoptions/ws
wss://nbstream.binance.com/eoptions/stream
/
at the end is no longer supported
- Raw stream like
wss://nbstream.binance.com/eoptions/illegal_parameter/stream?steams=<streamName>
orwss://fstream.binance.com/illegal_parameter/ws/<streamName>
is not supported, please use removeillegal_parameter/
before/ws
and/stream
.