Change Log
#
2024-04-19USDⓈ-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.
#
2024-04-09USDⓈ-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-01USDⓈ-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-11USDⓈ-M Futures
REST
- Add new Account Endpoints:
GET /fapi/v1/rateLimit/order
: query user order rate limits
#
2024-02-09USDⓈ-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-24USDⓈ-M Futures
Testnet WEBSOCKET
- The Websocket baseurl for testnet is updated to "wss://fstream.binancefuture.com"
#
2024-01-19Portfolio 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-11Portfolio 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 FAQUser 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 tradeGroupIdAdd 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-08USDⓈ-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-12USDⓈ-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-15USDⓈ-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-01COIN-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-01USDⓈ-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-19COIN-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-19European 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
.
#
2023-10-19USDⓈ-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
- Update Rate Limit to 500/5min/IP on Market Data Endpoints below:
GET /fapi/v1/fundingRate
GET /fapi/v1/fundingInfo
#
2023-10-16COIN-M Futures
REST
- New Market Data Endpoints
GET /dapi/v1/constituents
: query index constituents
#
2023-10-16USDⓈ-M Futures
REST
- New Market Data Endpoints
GET /fapi/v1/constituents
: query index constituents
#
2023-10-11USDⓈ-M Futures
REST
- Account Endpoints IP Weight Update:
GET /fapi/v1/income/asyn
: 5->1000GET /fapi/v1/order/asyn
: 5->1000GET /fapi/v1/trade/asyn
: 5->1000GET /fapi/v1/income/asyn/id
: 5->10GET /fapi/v1/order/asyn/id
: 5->10GET /fapi/v1/trade/asyn/id
: 5->10
#
2023-09-25COIN-M Futures
REST
- New Market Data Endpoints Update
GET /dapi/v1/fundingInfo
: query adjusted funding info
#
2023-09-25USDⓈ-M Futures
REST
- New Market Data Endpoints Update
GET /fapi/v1/fundingInfo
: query adjusted funding info
#
2023-09-22Portfolio Margin
Update on endpoints:
GET /papi/v1/um/positionRisk
: add response fieldliquidationPrice
GET /papi/v1/cm/positionRisk
: add response fieldliquidationPrice
GET /papi/v1/um/leverageBracket
: add response fieldnotionalCoef
GET /papi/v1/cm/leverageBracket
: add response fieldnotionalCoef
Websocket User Data Streams Update:
outboundAccountPosition
event add new field updateIdU
balanceUpdate
event add new field updateIdU
#
2023-09-20COIN-M Futures
REST
Update on
GET /dapi/v1/ticker/bookTicker
:- add response field
lastUpdateId
- add response field
Update on
GET /dapi/v1/account
:- add response field
updateTime
inassets
- add response field
#
2023-09-20USDⓈ-M Futures
REST
- Update on
GET /fapi/v1/ticker/bookTicker
:- add response field
lastUpdateId
- add response field
#
2023-09-19USDⓈ-M Futures
- New error code message for http
503
return code, endpoints below might have this response during high traffic:POST /fapi/v1/order
PUT /fapi/v1/order
DELETE /fapi/v1/order
POST /fapi/v1/batchOrder
PUT /fapi/v1/batchOrder
DELETE /fapi/v1/batchOrder
POST /fapi/v1/order/test
DELETE /fapi/v1/allOpenOrders
- This is a failure API operation and you can resend your request if you need.
#
2023-09-07COIN-M Futures
REST
- New endpoint
GET /dapi/v1/income/asyn
to get Download Id For Futures Transaction History - New endpoint
GET /dapi/v1/income/asyn/id
to get Futures Transaction History Download Link by Id
#
2023-09-05USDⓈ-M Futures
- As per the announcement, Self Trade Prevention is enabled at 2023-09-05.
- Price Match/ Good Till Date TIF/ Breakeven Price(detail in 2023-08-29 changelog) are released at 2023-09-05
#
2023-09-04Portfolio Margin
Expect 2023-09-07 Release
- Overall papi order ratelimit change from 2400 orders/min to 1200 orders/min, impacted endpoints are:
- POST
/papi/v1/um/order
- POST
/papi/v1/cm/order
- POST
/papi/v1/margin/order
- POST
/papi/v1/margin/order/oco
- POST
/papi/v1/um/conditional/order
- POST
/papi/v1/cm/conditional/order
- POST
#
2023-08-31COIN-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 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.
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.
#
2023-08-31USDⓈ-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 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.
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.
#
2023-08-29European Options
REST
GET /eapi/v1/account
: add new fieldriskLevel
to show account risk levelGET /eapi/v1/marginAccount
: add new fieldriskLevel
to show account risk level
Websocket User Data Stream
- Add new event
RISK_LEVEL_CHANGE
to show account riskLevel change
#
2023-08-29USDⓈ-M Futures
Self-Trade Prevention(Release Date TBD):
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 FAQUser 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 /fapi/v2/account
: Add new fieldtradeGroupId
in response to show user's tradeGroupId- Add optional parameter
selfTradePreventionMode
in the endpoints below to set order's STP mode:POST /fapi/v1/order
POST /fapi/v1/batchOrders
- Add new field
selfTradePreventionMode
in response of the endpoints below to show order's STP mode:POST /fapi/v1/order
POST /fapi/v1/batchOrders
POST /fapi/v1/order
POST /fapi/v1/order
GET /fapi/v1/order
GET /fapi/v1/openOrders
GET /fapi/v1/allOrders
PUT /fapi/v1/order
PUT /fapi/v1/batchOrders
DELETE /fapi/v1/order
DELETE /fapi/v1/batchOrders
- New order status
WEBSOCKET User Data Stream:
- Add new field
V
inORDER_TRADE_UPDATE
to order STP mode.
- Add new field
#
2023-08-25COIN-M Futures
- Binance Future is doing Websocket Service upgrade and the upgrade impacts the following:
- Connect websocket server without subscription:
- Before upgrade, user can connect by using:
wss://dstream.binance.com/ws
wss://dstream.binance.com/stream
wss://dstream.binance.com/ws/
wss://dstream.binance.com/stream/
- After upgrade, user can connect by using:
wss://dstream.binance.com/ws
wss://dstream.binance.com/stream
/
at the end is no longer supported
- Before upgrade, user can connect by using:
- Connect websocket server with subscription:
- Raw stream like
wss://dstream.binance.com/illegal_parameter/stream?steams=<streamName>
orwss://dstream.binance.com/illegal_parameter/ws/<streamName>
is not supported, please use removeillegal_parameter/
before/ws
and/stream
.
- Raw stream like
- Connect websocket server without subscription:
#
2023-08-19USDⓈ-M Futures
- Binance Future is doing Websocket Service upgrade and the upgrade impacts the following:
- Connect websocket server without subscription:
- Before upgrade, user can connect by using:
wss://fstream.binance.com/ws
wss://fstream.binance.com/stream
wss://fstream.binance.com/ws/
wss://fstream.binance.com/stream/
- After upgrade, user can connect by using:
wss://fstream.binance.com/ws
wss://fstream.binance.com/stream
/
at the end is no longer supported
- Before upgrade, user can connect by using:
- Connect websocket server with subscription:
- Raw stream like
wss://fstream.binance.com/illegal_parameter/stream?steams=<streamName>
orwss://fstream.binance.com/illegal_parameter/ws/<streamName>
is not supported, please use removeillegal_parameter/
before/ws
and/stream
.
- Raw stream like
- Connect websocket server without subscription:
#
2023-08-18Portfolio Margin
- New endpoints for Query Order:
GET /papi/v1/margin/order
: Query Margin Account OrderGET /papi/v1/margin/openOrders
: Query Current Margin Open OrderGET /papi/v1/margin/allOrders
: Query All Margin Account OrdersGET /papi/v1/margin/orderList
: Query Margin Account's OCOGET /papi/v1/margin/allOrderList
: Query Margin Account's all OCOGET /papi/v1/margin/openOrderList
: Query Margin Account's Open OCOGET /papi/v1/margin/myTrades
: Query Margin Account's Trade List
#
2023-08-14COIN-M Futures
- Update endpoint for Account/Trade:
GET /dapi/v1/income
: Add parameterpage
for pagination
#
2023-08-14USDⓈ-M Futures
- Update endpoint for Account/Trade:
GET /fapi/v1/income
: Add parameterpage
for pagination
#
2023-07-28Portfolio Margin
- New endpoints for account:
POST /papi/v1/asset-collection
: Fund Collection by Asset
#
2023-07-21European Options
REST
- New endpoint
GET /eapi/v1/income/asyn
to get Download Id For Option Transaction History - New endpoint
GET /eapi/v1/income/asyn/id
to get Option Transaction History Download Link by Id
#
2023-07-20Portfolio Margin
- New endpoints for account:
GET /papi/v1/um/adlQuantile
: UM Position ADL Quantile EstimationGET /papi/v1/cm/adlQuantile
: CM Position ADL Quantile Estimation
#
2023-07-19COIN-M Futures
REST
- Add field
notionalCoef
inGET /dapi/v2/leverageBracket
to show the bracket multiplier comparing to default leverage bracket
#
2023-07-18Portfolio Margin
- New endpoints for account:
POST /papi/v1/repay-futures-switch
: Change Auto-repay-futures StatusGET /papi/v1/repay-futures-switch
: Get Auto-repay-futures StatusPOST /papi/v1/repay-futures-negative-balance
: Repay futures Negative Balance
#
2023-07-18USDⓈ-M Futures
REST
- Add field
notionalCoef
inGET /fapi/v1/leverageBracket
to show the bracket multiplier comparing to default leverage bracket
#
2023-07-13European Options
Websocket Market Streams
- These change will be effective from 2023-07-14:
- Add field
T
in streams<symbol>@ticker
and<underlyingAsset>@ticker@<expirationDate>
to show transaction time - Add field
E
in stream<symbol>@depth<levels>
to show event time
- Add field
#
2023-07-13Portfolio Margin
- New USER DATA STREAM event
riskLevelChange
(effective 2023-07-14)
#
2023-07-12COIN-M Futures
REST
- New field
breakEvenPrice
represents Break-Even Price in position of response to:- GET /dapi/v1/account (HMAC SHA256)
- GET /dapi/v1/positionRisk (HMAC SHA256)
WEBSOCKET
- New field
bep
represents Break-Even Price in positionP
of payload to event: Balance and Position Update – "e": "ACCOUNT_UPDATE"
#
2023-07-11Portfolio Margin
REST
- Add new endpoint
POST /papi/v1/ping
for connectivity test
#
2023-07-04USDⓈ-M Futures
REST
- The following endpoints will be adjust to keep only recent three month data:
GET /fapi/v1/order
(effective 2023-07-27)GET /fapi/v1/allOrders
(effective 2023-07-27)GET /fapi/v1/userTrades
(exact time TBD)
- Please maintain and record old order/trade infomation or switch querying historical order/trade using new endpoint below:
- New endpoint
GET /fapi/v1/order/asyn
to get Download Id For Futures Order History - New endpoint
GET /fapi/v1/order/asyn/id
to get Futures Order History Download Link by Id - New endpoint
GET /fapi/v1/trade/asyn
to get Download Id For Futures Trade History - New endpoint
GET /fapi/v1/trade/asyn/id
to get Futures Trade History Download Link by Id
- New endpoint
#
2023-06-28USDⓈ-M Futures
Notice:
REST
- The following endpoints will no longer be supported from 2023-07-15:
GET /fapi/v1/account
GET /fapi/v1/balance
GET /fapi/v1/positionRisk
- Please switch to corresponding v2 endpoints:
GET /fapi/v2/account
GET /fapi/v2/balance
GET /fapi/v2/positionRisk
#
2023-06-22COIN-M Futures
Notice:
WEBSOCKET
- Raw stream like /ws?\<streamName> is not supported, for example
wss://dstream.binance.com/ws?btcusd@depth
is invalid. - Sending websocket message with invalid JSON format will cause disconnection now, returning this error
{"error":{"code":3,"msg":"Invalid JSON: expected value at line 1 column 1"}}
#
2023-06-22USDⓈ-M Futures
Notice:
WEBSOCKET
- Raw stream like /ws?\<streamName> is not supported, for example
wss://fstream.binance.com/ws?btcusdt@depth
is invalid. - Sending websocket message with invalid JSON format will cause disconnection now, returning this error
{"error":{"code":3,"msg":"Invalid JSON: expected value at line 1 column 1"}}
#
2023-06-19Portfolio Margin
REST
- Add fields
CONTRACT_PRICE
,priceProtect
in endpointsPOST /papi/v1/um/conditional/order
andPOST/papi/v1/cm/conditional/order
#
2023-06-16USDⓈ-M Futures
Notice:
It is recommended to use standard HTTP request formats, non-standard request formats will not be supported in fapi, below are some examples for correct code practice:
Escaping (") with '\x22' is no longer supported, please use the standard '%22' instead. It is necessary to URL encode the square brackets [] and the double quotes(")inside the square brackets.
[\x229151944646313025900\x22]
["9151944646313025900"]
DELETE /fapi/v1/batchOrders?origClientOrderIdList=%5B%229151944646313025900%22%5D
Non-standard nested JSON formats are not supported,
["{\"type\":\"LIMIT\",\"timeInForce\":\"GTC\"}"]
[{"type":"LIMIT","timeInForce":"GTC"}]
POST /fapi/v1/batchOrders?batchOrders=%5B%7B%22type%22%3A%22LIMIT%22%2C%22timeInForce%22%3A%22GTC%22%7D%5D
Using incorrect data type is not supported
["159856286502","159856313662"]
[159856286502,159856313662]
DELETE /fapi/v1/batchOrders?orderIdList=%5B159856286502%2C159856313662%5D
Invalid whitespace characters from the request parameters are not supported
POST symbol=BTCUSDT& price= 40000.0 & signature=2d24a314
POST symbol=BTCUSDT&&price=40000.0&signature=2d24a314
Passing empty values in request parameters is not supported
GET symbol=BTCUSDT&orderId=&signature=2d24a314
Suggest:
GET symbol=BTCUSDT&signature=2d24a314
#
2023-06-14COIN-M Futures
WEBSOCKET
- New field
i
for quote asset and index price added in streams<symbol>@markPrice
and<pair>@markPrice
#
2023-06-14USDⓈ-M Futures
WEBSOCKET
- New WebSocket stream
!assetIndex@arr
OR<assetSymbol>@assetIndex
for multi-assets mode asset index update
#
2023-06-01Portfolio Margin
REST
- The endpoints below will be deployed on 2023-06-02:
- New endpoints
GET /papi/v1/um/income
andGET /papi/v1/cm/income
to query portfolio margin UM/CM income history - New endpoints
GET /papi/v1/um/account
andGET /papi/v1/cm/account
to query portfolio margin UM/CM account history
- New endpoints
#
2023-05-31USDⓈ-M Futures
WEBSOCKET
- Add user data stream:
- new event
CONDITIONAL_ORDER_TRIGGER_REJECT
to the order reject reason for triggered TP/SL order
- new event
#
2023-05-30European Options
General Information on Endpoints
- For
GET
endpoints, parameters must be sent as aquery string
without setting content type in the http headers.
#
2023-05-24USDⓈ-M Futures
REST
GET /fapi/v1/pmExchangeInfo
will be deprecated on 5/29 due to removingnotionalLimit
restriction.
#
2023-05-05USDⓈ-M Futures
REST
- New endpoints
PUT /fapi/v1/order
andPUT /fapi/v1/batchOrders
to support limit order modify - New endpoint
GET /fapi/v1/orderAmendment
to get order modify history
WEBSOCKET
- New type "AMENDMENT" as order modify in Execution Type
x
of Order Update eventORDER_TRADE_UPDATE
#
2023-05-04Portfolio Margin
- API doc for portfolio margin
#
2023-04-17COIN-M Futures
RELEASE DATE TBD
The recvWindow
check will also be performed when orders reach matching engine. The recvWindow
will be checked more precisely on order placing endpoints.
recvWindow Logic Before Release:
- The order placing requests are valid if
recvWindow
+timestamp
=> REST API service servertimestamp
recvWindow Logic After Release:
Add new recwWindow check: the order placing requests are valid if
recvWindow
+timestamp
=> matching enginetimestamp
Impacted Endpoints:
- POST /dapi/v1/order (HMAC SHA256)
- PUT /dapi/v1/order (HMAC SHA256)
- POST /dapi/v1/batchOrders (HMAC SHA256)
- PUT /dapi/v1/batchOrders (HMAC SHA256)
#
2023-04-17USDⓈ-M Futures
RELEASE DATE 2023-04-18
The recvWindow
check will also be performed when orders reach matching engine. The recvWindow
will be checked more precisely on order placing endpoints.
recvWindow Logic Before Release:
- The order placing requests are valid if
recvWindow
+timestamp
=> REST API service servertimestamp
recvWindow Logic After Release:
Add new recwWindow check: the order placing requests are valid if
recvWindow
+timestamp
=> matching enginetimestamp
Impacted Endpoints:
- POST /fapi/v1/order
- PUT /fapi/v1/order
- POST /fapi/v1/batchOrders
- PUT /fapi/v1/batchOrders
#
2023-03-28USDⓈ-M Futures
Referal Rebate Logic Before Release
- For every trade,the referal rebate balance change will be reflected in
ACCOUNT_UPDATE
event of USER-DATA-STREAM in real time:
Referal Rebate Logic After Release
- Referral rebates are aggregated every 20 minutes and reflected as a single push in the
ACCOUNT_UPDATE
event of the USER-DATA-STREAM, showing the total sum of rebates earned from multiple referrals.
#
2023-03-08USDⓈ-M Futures
RELEASE DATE 2023-03-22
Order Logic Before Release:
- When placing order with
timeInForce
FOK
orGTX
(Post-only), user will get order response withstatus
= “NEW“ and correspondingorder_trade_update
withx
= “NEW”,X
= “NEW”. If the orders can't meet execution criteria, user will receive another websocketorder_trade_update
messagex
= “EXPIRED”,X
= “EXPIRED”. The order can be found inGET /fapi/v1/order
orGET /fapi/v1/allOrders
.
Order Logic After Release:
- When placing order with
timeInForce
FOK
orGTX
(Post-only), if the order can't meet execution criteria, order will get rejected directly and receive error response, noorder_trade_update
message in websocket. The order can't be found inGET /fapi/v1/order
orGET /fapi/v1/allOrders
.
- Impacted Endpoints:
- POST /fapi/v1/order
- POST /fapi/v1/batchOrders
- GET /fapi/v1/order
- GET /fapi/v1/allOrders
#
2023-02-02European Options
REST
- Endpoint
POST /eapi/v1/transfer
is disabled.
#
2023-01-11European Options
REST
- Add endpoint
GET /eapi/v1/order
to check order status.
#
2023-01-04USDⓈ-M Futures
WEBSOCKET
- Delete Order Status
NEW_INSURANCE
andNEW_ADL
in Order Update Event
#
2022-12-16COIN-M Futures
WEBSOCKET
- New WebSocket stream
!contractInfo
for symbol information update
#
2022-12-16USDⓈ-M Futures
WEBSOCKET
- New WebSocket stream
!contractInfo
for symbol information update
#
2022-12-13European Options
WEBSOCKET
- Add
u
andpu
in stream<symbol>@depth1000
to get diff orderbook update.
#
2022-12-09European Options
REST
- Add updateId field
u
inGET /eapi/v1/depth
- Add parameter
underlying
inGET /eapi/v1/exerciseHistory
to query exercise histroy by underlying
#
2022-11-29COIN-M Futures
WEB SOCKET USER DATA STREAM
- New WebSocket stream
STRATEGY_UPDATE
in USER-DATA-STREAM: update when a strategy is created/cancelled/expired, ...etc. - New WebSocket stream
GRID_UPDATE
in USER-DATA-STREAM: update when a sub order of a grid is filled or partially filled.
#
2022-11-29USDⓈ-M Futures
WEB SOCKET USER DATA STREAM
- New WebSocket stream
STRATEGY_UPDATE
in USER-DATA-STREAM: update when a strategy is created/cancelled/expired, ...etc. - New WebSocket stream
GRID_UPDATE
in USER-DATA-STREAM: update when a sub order of a grid is filled or partially filled.
#
2022-11-18European Options
REST
- New endpoint
GET /eapi/v1/openInterest
is added to get options open interest for specific underlying on certain expiration date.
WEBSOCKET
- New stream
<underlyingAsset>@openInterest@<expirationDate>
is added for real-time option open interest feed.
#
2022-11-16European Options
WEBSOCKET
- New trade stream
<underlyingAsset>@trade
is added for all option trades on specific underlying asset. - Adjust format in stream
option_pair
.
#
2022-11-03European Options
REST
- New endpoint for Auto-Cancel All Open Orders will be added on 2022-11-07:
POST /eapi/v1/countdownCancelAll
:Set Auto-Cancel All Open Orders (Kill-Switch) ConfigGET /eapi/v1/countdownCancelAll
:Get Auto-Cancel All Open Orders (Kill-Switch) ConfigPOST /eapi/v1/countdownCancelAllHeartBeat
:Auto-Cancel All Open Orders (Kill-Switch) Heartbeat
#
2022-10-13COIN-M Futures
Note: This change will be effictive on 2022-10-17
REST RATE LIMIT WEIGHT
Endpoint GET /dapi/v1/ticker/bookTicker
Weight Update:
2 for a single symbol;
5 when the symbol parameter is omitted
#
2022-10-13USDⓈ-M Futures
Note: This change will be effictive on 2022-10-17
REST RATE LIMIT WEIGHT
Endpoint GET /fapi/v1/ticker/bookTicker
Weight Update:
2 for a single symbol;
5 when the symbol parameter is omitted
#
2022-09-22COIN-M Futures
- Add new endpoint for Portfolio Margin:
GET /dapi/v1/pmAccountInfo
: Get Portfolio Margin current account information.
#
2022-09-22USDⓈ-M Futures
- Update endpoint for Account/Trade:
GET /fapi/v1/income
: Support more incomeType
- Add new endpoint for Portfolio Margin:
GET /fapi/v1/pmAccountInfo
: Get Portfolio Margin current account information.
#
2022-09-20European Options
WEBSOCKET
- New streams
<underlyingAsset>@markPrice
and<underlyingAsset>@ticker@<expirationDate>
are added. - Streams
<!miniTicker@arr>
will be deprecated on 2022/10/30.
#
2022-09-14European Options
REST
- Adjust endpoint field
strikePrice
,makerFeeRate
,takerFeeRate
,minQty
,maxQty
,initialMargin
,maintenanceMargin
,minInitialMargin
,minMaintenanceMargin
to string in endpointGET /eapi/v1/exchangeInfo
- Only finished orders within 5 days can be queried in
GET /eapi/v1/historyOrders
#
2022-09-05European Options
REST
- Adjust response result in endpoint
DELETE /eapi/v1/allOpenOrdersByUnderlying
#
2022-08-22European Options
REST
- Add
rateLimits
information in endpointGET /eapi/v1/exchangeInfo
- Parameters
symbol
set to not mandatory inGET /eapi/v1/userTrades
#
2022-07-27COIN-M Futures
REST RATE LIMIT WEIGHT
- The weight of endpoint
GET /dapi/v1/trades
is updated to 5
#
2022-07-27USDⓈ-M Futures
REST RATE LIMIT WEIGHT
- The weight of endpoint
GET /fapi/v1/trades
is updated to 5
#
2022-06-28COIN-M Futures
REST
- New endpoint
GET /dapi/v1/pmExchangeInfo
to get current Portfolio Margin exchange trading rules.
#
2022-06-28USDⓈ-M Futures
REST
- New endpoint
GET /fapi/v1/pmExchangeInfo
to get current Portfolio Margin exchange trading rules.
#
2022-04-28COIN-M Futures
REST
- New endpoints
PUT /dapi/v1/order
andPUT /dapi/v1/batchOrders
to support limit order modify - New endpoint
GET /dapi/v1/orderAmendment
to get order modify history
WEBSOCKET
- New type "AMENDMENT" as order modify in Execution Type
x
of Order Update eventORDER_TRADE_UPDATE
#
2022-04-14COIN-M Futures
WEB SOCKET USER DATA STREAM
- New WebSocket stream
ACCOUNT_CONFIG_UPDATE
in USER-DATA-STREAM for leverage changed update
#
2022-04-08USDⓈ-M Futures
WEBSOCKET
- New base url
wss://nbstream.binance.com/lvt-p
for BLVT streams<tokenName>@tokenNav
and<tokenName>@nav_kline_<interval>
. More details: Websocket BLVT Info Streams and Websocket BLVT NAV Kline/Candlestick Streams
#
2022-03-01USDⓈ-M Futures
REST
- New endpoint
GET /fapi/v1/income/asyn
to get Download Id For Futures Transaction History - New endpoint
GET /fapi/v1/income/asyn/id
to get Futures Transaction History Download Link by Id
#
2022-02-18COIN-M Futures
REST
- The maximum value of
limit
inGET /dapi/v1/userTrades
is adjusted to 1000
#
2022-02-10USDⓈ-M Futures
REST
- Update
GET /fapi/v2/account
endpoints:- If user is in multiAssetsMargin mode, all assets will be included in calculation for fields
totalInitialMargin``totalMaintMargin``totalWalletBalance``totalUnrealizedProfit``totalMarginBalance``totalPositionInitialMargin``totalOpenOrderInitialMargin``totalCrossWalletBalance``totalCrossUnPnl``availableBalance``maxWithdrawAmount
and the results will be show as value in USD - If user is in singleAssetsMargin mode, only USDT assets are included in the calculation(same as before)
- If user is in multiAssetsMargin mode, all assets will be included in calculation for fields
#
2021-12-30USDⓈ-M Futures
WEBSOCKET
- New connection method for WEBSOCKET.
- Base Url is
wss://fstream-auth.binance.com
- Streams can be access either in a single raw stream or a combined stream
- Raw streams are accessed at
/ws/<streamName>?listenKey=<validateListenKey>
- Combined streams are accessed at
/stream?streams=<streamName1>/<streamName2>/<streamName3>&listenKey=<validateListenKey>
<validateListenKey>
must be a valid listenKey when you establish a connection.
- Base Url is
- More details: Websocket Market Streams and User Data Streams
#
2021-11-02USDⓈ-M Futures
REST
- New endpoint
GET /fapi/v1/assetIndex
to get asset index for Multi-Assets mode margin asset
#
2021-08-18COIN-M Futures
REST
- New field
positionAmt
as position amount in response ofGET /dapi/v1/account
#
2021-08-17COIN-M Futures
REST
- New endpoints
PUT /dapi/v1/order
andPUT /dapi/v1/batchOrders
to support limit order modify - New endpoint
GET /dapi/v1/orderAmendment
to get order modify history
WEBSOCKET
- New type "AMENDMENT" as order modify in Execution Type
x
of Order Update eventORDER_TRADE_UPDATE
#
2021-07-23COIN-M Futures
REST
- New field
updateTime
as last update time of asset and position in response ofGET /dapi/v1/account
andGET /dapi/v1/positionRisk
#
2021-07-06COIN-M Futures
REST
- New fields in the response of
GET /dapi/v1/exchangeInfo
:- "liquidationFee" for liquidation fee rate
- "marketTakeBound" for he max price difference rate( from mark price) a market order can make
#
2021-07-06USDⓈ-M Futures
REST
- New field
updateTime
as last update time of asset and position in response ofGET /fapi/v2/account
andGET /fapi/v2/positionRisk
- New fields in the response of
GET /fapi/v1/exchangeInfo
:- "liquidationFee" for liquidation fee rate
- "marketTakeBound" for he max price difference rate( from mark price) a market order can make
#
2021-06-15USDⓈ-M Futures
WEBSOCKET
- New fields "q" and "i" for quote asset and index price added in stream
<symbol>@compositeIndex
REST
- Update endpoints:
- New fields
component
andquoteAsset
as component asset and quote asset added in response ofGET /fapi/v1/indexInfo
- New fields
#
2021-05-06COIN-M Futures
WEBSOCKET
- New field "bc" for balance change in event "ACCOUNT_UPDATE"
#
2021-05-06USDⓈ-M Futures
WEBSOCKET
- Update streams:
- Previous Leverage Update event
ACCOUNT_CONFIG_UPDATE
expanded as account configuration update event, including leverage update and Multi-Assets margin status update. - Balance and Position Update event
ACCOUNT_UPDATE
add new event reason typem
asAUTO_EXCHANGE
to represent Multi-Assets margin auto-exchange event
- Previous Leverage Update event
REST
New endpoints:
POST /fapi/v1/multiAssetsMargin
to change Multi-Assets margin modeGET /fapi/v1/multiAssetsMargin
to check Multi-Assets margin mode
Update endpoints:
- New object
assets
as asset information in response ofGET /fapi/v1/exchangeInfo
. - New field
marginAvailable
in response ofGET /fapi/v2/balance
andGET /fapi/v2/account
to indicate whether the asset can be used as margin in Multi-Assets mode.
- New object
#
2021-04-27COIN-M Futures
WEBSOCKET
- The following liquidation orders streams do not push realtime order data anymore. Instead, they push snapshot order data at a maximum frequency of 1 order push per second.:
<symbol>@forceOrder
!forceOrder@arr
REST
- The endpoint
GET /dapi/v1/allForceOrders
stop being maintained and no longer accepts request.
#
2021-04-27USDⓈ-M Futures
WEBSOCKET
- The following liquidation orders streams do not push realtime order data anymore. Instead, they push snapshot order data at a maximum frequency of 1 order push per second.:
<symbol>@forceOrder
!forceOrder@arr
REST
- The endpoint
GET /fapi/v1/allForceOrders
stop being maintained and no longer accepts request.
#
2021-04-22USDⓈ-M Futures
WEBSOCKET
- New field "bc" for balance change in event "ACCOUNT_UPDATE"
#
2021-03-10COIN-M Futures
REST
- The query time period for endpoint
GET /dapi/v1/allForceOrders
must be less than 7 days (default as the recent 7 days).
#
2021-03-02USDⓈ-M Futures
New endpoint
GET /fapi/v1/indexPriceKlines
to get index price kline/candlestick data.New endpoint
GET /fapi/v1/markPriceKlines
to get mark price kline/candlestick data.
#
2021-02-24USDⓈ-M Futures
REST RATE LIMIT WEIGHT
- The weight of endpoint
GET /fapi/v2/balance
is updated to 5 - The weight of endpoint
GET /fapi/v2/positionRisk
is updated to 5
#
2021-02-22USDⓈ-M Futures
REST RATE LIMIT WEIGHT
- The weight of endpoint
GET /fapi/v1/income
is updated to 30
REST
- The query time period for endpoint
GET /fapi/v1/allOrders
must be less than 7 days. - The query time period for endpoint
GET /fapi/v1/allForceOrders
must be within the recent 7 days.
#
2021-01-26COIN-M Futures
REST RATE LIMIT WEIGHT
- Following endpoints' weights will be updated to 20 with symbol and 50 without symbol:
GET /dapi/v1/allForceOrders
GET /dapi/v1/forceOrders
#
2021-01-26USDⓈ-M Futures
WEB SOCKET USER DATA STREAM
- New WebSocket stream
ACCOUNT_CONFIG_UPDATE
in USER-DATA-STREAM for leverage changed update
REST RATE LIMIT WEIGHT
- Following endpoints' weights will be updated to 20 with symbol and 50 without symbol:
GET /fapi/v1/allForceOrders
GET /fapi/v1/forceOrders
REST
- New filter "MIN_NOTIONAL" whicht defines the minimum notional value allowed for an order on a symbol, and shown in the
/fapi/v1/exchangeInfo
#
2021-01-21COIN-M Futures
The regular expression rule for newClientOrderId
updated as ^[\.A-Z\:/a-z0-9_-]{1,36}$
#
2021-01-21USDⓈ-M Futures
The regular expression rule for newClientOrderId
updated as ^[\.A-Z\:/a-z0-9_-]{1,36}$
#
2021-01-04USDⓈ-M Futures
REST RATE LIMIT WEIGHT
Following endpoints will use new weight rule based on the paremeter "LIMIT" in the request:
GET /fapi/v1/klines
GET /fapi/v1/continuousKlines
Following endpoints' weights will be updated to 20:
GET /fapi/v1/historicalTrades
GET /fapi/v1/allForceOrders
GET /fapi/v1/forceOrders
GET /fapi/v1/aggTrades
#
2020-12-30COIN-M Futures
REST
Following DAPI endpoints will use new weight rule based on the parameter "LIMIT" in the request:
GET /dapi/v1/klines
GET /dapi/v1/continuousKlines
GET /dapi/v1/indexPriceKlines
GET /dapi/v1/markPriceKlines
Following DAPI endpoints' weights will be updated to 20:
GET /dapi/v1/historicalTrades
GET /dapi/v1/allForceOrders
GET /dapi/v1/forceOrders
GET /dapi/v1/aggTrades
#
2020-12-08USDⓈ-M Futures
WEBSOCKET
- New field
e
for event type in payload of streams<symbol>@bookTicker
and!bookTicker
- New field
P
for estimated settle price in payload of streams<symbol>@markPrice
,<symbol>@markPrice@1s
,!markPrice@arr
, and!markPrice@arr@1s
. - New stream
<pair>_<contractType>@continuousKline_<interval>
for continuous contract kline
REST API
New field "estimatedSettlePrice" in response to
GET /fapi/v1/premiumIndex
New fields in response to
GET /fapi/v1/exchangeInfo
:- "pair"
- "contractType"
- "deliveryDate"
- "onboardDate"
New endpoint
GET /fapi/v1/continuousKlines
to get continuous contract kline data
ENUM
- Contract types:
- PERPETUAL
- CURRENT_MONTH
- NEXT_MONTH
- CURRENT_QUARTER
- NEXT_QUARTER
#
2020-11-27COIN-M Futures
- New endpoint
GET /dapi/v1/commissionRate
to get user commission rate.
#
2020-11-27USDⓈ-M Futures
- New endpoint
GET /fapi/v1/commissionRate
to get user commission rate.
#
2020-11-13USDⓈ-M Futures
WEB SOCKET STREAM
- In order to provide users with more secure and stable services, the update time of
<symbol>depth@0ms
and<symbol>@depth<level>@0ms
is dynamically adjusted according to the total amount of data traffic and other objective conditions.
#
2020-11-10USDⓈ-M Futures
- New field "marginAsset" for margin asset in the response to
GET /fapi/v1/exchangeInfo
. - New field "positionAmt" for position amount in the response to
GET /fapi/v2/account
.
#
2020-11-09USDⓈ-M Futures
WEB SOCKET USER DATA STREAM
Please notice: new streamlined and optimized push rules on event ACCOUNT_UPDATE
in USER-DATA-STREAM
When an asset of a user is changed:
- Only this asset and its balance information will be pushed
- Other assets and information will no longer be pushed even the balances may not be 0
- If none of the open positions change, the position "P" will only return an empty
[]
When a position or the margin type of a symbol is changed:
- "P" will push the details in the "BOTH" position of this symbol
- If the change happens in "LONG" or "SHORT" position, the changed "LONG" or "SHORT" position of this symbol will be pushed
- Initialized "LONG" or "SHORT" isolated position of this symbol will also be pushed
- Position information of other symbols will no longer be pushed, even their positions may not be 0
In short, the full information of assets and positions should be obtained via the related RESTful endpoints(
GET /fapi/v2/account
andGET /fapi/v2/positionRisk
), and the locally cached asset or position data can be updated via the eventACCOUNT_UPDATE
in Websocket USER-DATA-STREAM with the information of changed asset or position.Please visit here to get examples for helping to understand the upgrade.
#
2020-10-27USDⓈ-M Futures
WEB SOCKET STREAM
- The maximum stream number that a single connection can listen to changes as 200.
#
2020-10-10USDⓈ-M Futures
WEBSOCKET
- New WebSocket streams
<symbol>@compositeIndex
for composite index symbol information.
#
2020-10-09USDⓈ-M Futures
- New endpoint
GET /fapi/v1/indexInfo
to get information of composite index.
#
2020-09-18USDⓈ-M Futures
- New endpoint
GET /fapi/v1/apiTradingStatus
to get futures API trading quantitative rules indicators
#
2020-09-16USDⓈ-M Futures
- New endpoint
GET /fapi/v1/lvtKlines
to get gistorical BLVT Kline.
The BLVT NAV system is working relatively with Binance Futures, so the endpoint is based on fapi.
WEBSOCKET
- New WebSocket streams for BLVT
The BLVT NAV system is working relatively with Binance Futures, so the endpoint is based on futures websocket service.
<tokenName>@tokenNav
for BLVT Info streams<tokenName>@nav_kline_<interval>
for BLVT NAV Kline streams
#
2020-09-09USDⓈ-M Futures
- Some orders that were cancelled/expired will be removed gradually from API endpoints.
- Orders that meet criteria
- order status is
CANCELED
orEXPIRED
, AND - order has NO filled trade, AND
- created time + 7 days < current time
- order status is
- These endpoints are affected:
GET /fapi/v1/order
GET /fapi/v1/allOrders
- Orders that meet criteria
#
2020-08-16COIN-M Futures
WEBSOCKET
- Websocket Request for user data:
<listenKey>@account
request for user's account information<listenKey>@balance
request for user's account balance<listenKey>@balance
request for user's position information
REST
- New endpoint
GET /dapi/v1/adlQuantile
to get the positions' ADL quantile estimation values
#
2020-08-14USDⓈ-M Futures
- New field "indexPrice" in response to endpoint
GET /fapi/v1/premiumIndex
. - New field "i" for indexPrice in payload of ws streams:
<symbol>@markPrice
,<symbol>@markPrice@1s
,!markPrice@arr
,!markPrice@arr@1s
#
2020-08-12COIN-M Futures
- New endpoint
GET /dapi/v1/forceOrders
to get the user's force orderes.
#
2020-08-12USDⓈ-M Futures
- New endpoint
GET /fapi/v1/forceOrders
to get the user's force orderes.
#
2020-08-11COIN-M Futures
COIN MARGINED PERPETUAL FUTURES
New contract type ("contractType")
PERPETUAL
for coin margined perpetual futures countract.New fields in the reponse to endpoint
GET /dapi/v1/premiumIndex
:lastFundingRate
for the lasted funding rate of the perpetual futures contractnextFundingTime
for the next funding time of the perpetual futures contract
New endpoint
GET /dapi/v1/fundingRate
to get funding rate history of perpetual futuresNew fields in the payload of WSS
<symbol>@markPrice
,<symbol>@markPrice@1s
,<pair>@markPrice
, and<pair>@markPrice@1s
:r
for the lasted funding rate of the perpetual futures contractT
for the next funding time of the perpetual futures contract
#
2020-07-30USDⓈ-M Futures
- New endpoint
GET /fapi/v1/adlQuantile
to get the positions' ADL quantile estimation values
#
2020-07-22COIN-M Futures
- New endpoints of coin margined futures trading data:
GET /futures/data/openInterestHist
GET /futures/data/topLongShortAccountRatio
GET /futures/data/topLongShortPositionRatio
GET /futures/data/globalLongShortAccountRatio
GET /futures/data/takerBuySellVol
GET /futures/data/basis
#
2020-07-17USDⓈ-M Futures
- Weights of endpoint
GET /fapi/v1/income
has been changed as 20
#
2020-07-02USDⓈ-M Futures
WEBSOCKET
- New field "m" for event reason type in event "ACCOUNT_UPDATE"
- New field "rp" for the realized profit of the trade in event "ORDER_TRADE_UPDATE"
#
2020-06-15USDⓈ-M Futures
- New fields in responses to
GET /fapi/v2/account
andGET /fapi/v2/balance
:availableBalance
maxWithdrawAmount
#
2020-06-04USDⓈ-M Futures
- New endpoints of version 2 of fapi, having better performance than the v1 endpoints:
GET /fapi/v2/account
GET /fapi/v2/balance
#
2020-06-02USDⓈ-M Futures
- New endpoint
GET /fapi/v2/positionRisk
in version 2 of fapi:- User can choose to send specific "symbol".
- All symbols in the market can be returned.
- Different responses for "One-way" or "Hedge" position mode.
- Better performance than the v1 endpoint.
#
2020-05-18USDⓈ-M Futures
- New parameter
closePosition
for endpointPOST /fapi/v1/order
:
If aSTOP_MARKET
orTAKE_PROFIT_MARKET
order withclosePosition=true
is triggered,all of the current long position( ifSELL
order) or current short position( ifBUY
order) will be closed. - New field
closePosition
in response to endpoints:POST /fapi/v1/order
POST /fapi/v1/batchOrders
GET /fapi/v1/order
DELETE /fapi/v1/order
DELETE /fapi/v1/batchOrders
GET /fapi/v1/openOrder
GET /fapi/v1/openOrders
GET /fapi/v1/allOrders
#
2020-05-18USDⓈ-M Futures
- Some orders that were cancelled/expired will be removed gradually from API endpoints, but they are still available from Web UI.
- Orders that meet criteria
- order status is
CANCELED
orEXPIRED
, AND - order has NO filled trade, AND
- created time + 30 days < current time
- order status is
- These endpoints are affected:
GET /fapi/v1/order
GET /fapi/v1/allOrders
- Orders that meet criteria
#
2020-05-15USDⓈ-M Futures
- New fields in payloads of
<symbol>@bookTicker
and!bookTicker
:E
for event timeT
for transaction time
#
2020-05-14USDⓈ-M Futures
- New field
time
for transaction time in response to endpoints:GET /fapi/v1/ticker/price
GET /fapi/v1/ticker/bookTicker
GET /fapi/v1/openInterest
#
2020-05-11USDⓈ-M Futures
- New endpoint
POST /fapi/v1/countdownCancelAll
to cancel all open orders of the specified symbol at the end of the specified countdown.
This rest endpoint means to ensure your open orders are canceled in case of an outage. The endpoint should be called repeatedly as heartbeats so that the existing countdown time can be canceled and repalced by a new one.
#
2020-05-06USDⓈ-M Futures
REST
- Endpoint
GET /fapi/v1/leverageBracket
is changed as "USER-DATA". It need to be signed, and timestamp is needed.
WEB SOCKET USER DATA STREAM
- Please notice: event
ACCOUNT_UPDATE
in USER-DATA-STREAM will be pushed with only account balance or relative position when "FUNDING FEE" occurs.- When "FUNDING FEE" occurs in a crossed position,
ACCOUNT_UPDATE
will be pushed with only the balanceB
(including the "FUNDING FEE" asset only), without any positionP
message. - When "FUNDING FEE" occurs in an isolated position,
ACCOUNT_UPDATE
will be pushed with only the balanceB
(including the "FUNDING FEE" asset only) and the relative position messageP
( including the isolated position on which the "FUNDING FEE" occurs only, without any other position message).
- When "FUNDING FEE" occurs in a crossed position,
#
2020-04-25USDⓈ-M Futures
New fields in USER DATA STREAM event
ORDER_TRADE_UPDATE
:cp
stands for Close-All conditional orderAP
for Activation Price withTRAILING_STOP_MARKET
ordercr
for Callback Rate withTRAILING_STOP_MARKET
order
New USER DATA STREAM event
MARGIN_CALL
.
#
2020-04-17USDⓈ-M Futures
- New parameter
newOrderRespType
for response type in endpointPOST /fapi/v1/order
.ACK
andRESULT
are supported. And fornewOrderRespType= RESULT
:MARKET
order: the final FILLED result of the order will be return directly.LIMIT
order with specialtimeInForce
: the final status result of the order(FILLED or EXPIRED) will be returned directly.
#
2020-04-14USDⓈ-M Futures
WEB SOCKET STREAM
- WebSocket connections have a limit of 10 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 200 streams.
#
2020-04-09USDⓈ-M Futures
- New endpoint of futures trading data:
GET /futures/data/takerlongshortRatio
#
2020-04-08USDⓈ-M Futures
- New endpoint
GET /fapi/v1/positionSide/dual
to get current position mode. - New endpoint
POST /fapi/v1/batchOrders
to place multiple orders.
#
2020-04-06USDⓈ-M Futures
Please notice: event
ACCOUNT_UPDATE
in USER-DATA-STREAM will not be pushed without update of account balances or positions.ACCOUNT_UPDATE
will be pushed only when update happens on user's account, including changes on balances, positions, or margin type.- Unfilled orders or cancelled orders will not make the event
ACCOUNT_UPDATE
pushed, since there's no change on positions. - Only positions of symbols with non-zero isolatd wallet or non-zero position amount will be pushed in the "position" part of the event
ACCOUNT_UPDATE
.
New endpoint
POST /fapi/v1/positionSide/dual
to change position mode: Hedge Mode or One-way Mode.New parameter
positionSide
in the following endpoints:POST /fapi/v1/order
POST /fapi/v1/positionMargin
New field
positionSide
in the responses to the following endpoints:POST /fapi/v1/order
GET /fapi/v1/order
DELETE /fapi/v1/order
DELETE /fapi/v1/batchOrders
GET /fapi/v1/openOrder
GET /fapi/v1/openOrders
GET /fapi/v1/allOrders
GET /fapi/v1/account
GET /fapi/v1/positionMargin/history
GET /fapi/v1/positionRisk
GET /fapi/v1/userTrades
New field
ps
for "position side"in USER_DATA_STREAM eventsACCOUNT_UPDATE
andORDER_TRADE_UPDATE
.
#
2020-03-30USDⓈ-M Futures
- New endpoints of futures trading data:
GET /futures/data/openInterestHist
GET /futures/data/topLongShortAccountRatio
GET /futures/data/topLongShortPositionRatio
GET /futures/data/globalLongShortAccountRatio
#
2020-02-26- New order type:
TRAILING_STOP_MARKET
#
2020-02-20USDⓈ-M Futures
- New endpoint to query specific current open order:
GET /fapi/v1/openOrder
#
2020-02-17USDⓈ-M Futures
- Update time changed as 1000ms for streams
<symbol>@ticker
and!ticker@arr
- New diff depth data with 500ms updates:
<symbol>@depth@500ms
- New partial depth data with 500ms updates:
<symbol>@depth<level>@500ms
#
2020-02-12USDⓈ-M Futures
New SDK and Code Demonstration on Java
Faster mark price websocket data with 1s updates:
<symbol>@markPrice@1s
and!markPrice@arr@1s
#
2020-02-05USDⓈ-M Futures
- New market data endpoint
GET /fapi/v1/leverageBracket
to check notional and leverage brackets.
#
2020-01-19USDⓈ-M Futures
- "cumQty" is going to be removed from the responses to
DELETE /fapi/v1/order
,DELETE /fapi/v1/batchOrders
and otherorder
relatived endpoints in the coming weeks.
Please use "executedQty" instead.
#
2020-01-17USDⓈ-M Futures
- New SDK and Code Demonstration on Python
#
2020-01-06USDⓈ-M Futures
- Faster diff data with real time updates:
<symbol>@depth@0ms
#
2020-01-03USDⓈ-M Futures
New endpoints related to isolated position:
POST /fapi/v1/marginType
POST /fapi/v1/positionMargin
GET /fapi/v1/positionMargin/history
New field in response to
GET /fapi/v1/positionRisk
related to isolated position:marginType
isolatedMargin
New field in response to
GET /fapi/v1/account
related to isolated position:isolated
New field in event
ACCOUNT_UPDATE
:- "cw" for cross wallet
- "mt" for margin type
- "iw" for isolated wallet (if isolated)
#
2019-12-19USDⓈ-M Futures
- New endpoint
GET /fapi/v1/openInterest
to get present open interest of a specific symbol.
#
2019-12-18USDⓈ-M Futures
- New event type in user data stream:
listenKeyExpired
.
#
2019-12-12USDⓈ-M Futures
- New endpoint
DELETE /fapi/v1/allOpenOrders
to cancel all open orders of a specific symbol. - New endpoint
DELETE /fapi/v1/batchOrders
to cancel a list of open orders. reduceOnly
has been supported in orders with type:TAKE_PROFIT
TAKE_PROFIT_MARKET
STOP
STOP_MARKET
#
2019-11-29USDⓈ-M Futures
- New endpoint
GET /fapi/v1/allForceOrders
to get all liquidation orders. - New websocket streams:
<symbol>@forceOrder
for liquidation order streams!forceOrder@arr
for all market liquidation order streams
#
2019-11-25USDⓈ-M Futures
GET /fapi/v1/account
has new field:positions
- Added new field
time
for order creation time in:GET /fapi/v1/openOrders
GET /fapi/v1/order
GET /fapi/v1/allOrders
#
2019-11-15USDⓈ-M Futures
- New websocket streams:
!miniTicker@arr
: All market 24hr mini-tickers stream.!ticker@arr
: : All market 24hr tickers stream.
#
2019-11-12USDⓈ-M Futures
- WSS now supports live subscribing/unsubscribing to streams.
#
2019-11-05USDⓈ-M Futures
- New order type:
STOP_MARKET
,TAKE_PROFIT_MARKET
.
- New parameter
workingType
inPOST /fapi/v1/order
:
order with stop price can be triggered by "CONTRACT_PRICE" or "MARK_PRICE" - New keys in USER-DATA-STREAMS:
- in
ORDER_TRADE_UPDATE
:- "T" as transaction time
- "wt" as workingType
- in
ACCOUNT_UPDATE
:- "T" as transaction time
- in
#
2019-10-28USDⓈ-M Futures
- New rest endpoint for income flow history
GET /fapi/v1/income
#
2019-10-25USDⓈ-M Futures
- Added "up" in event
ACCOUNT_UPDATE
in user data stream: the unrealized PnL of the position. - Added "R" in event
ORDER_TRADE_UPDATE
in user data stream, showing if the trade is reduce only.
#
2019-10-24USDⓈ-M Futures
- New WebSocket streams for booktickers added:
<symbol>@bookTicker
and!bookTicker
. - New WebSocket streams for partial orderbook added:
<symbol>@depth<levels>
and<symbol>@depth<levels>@100ms
- Faster diff data with 100ms updates:
<symbol>@depth@100ms
- Added
Update Speed
: toWebsocket Market Streams
#
2019-10-18USDⓈ-M Futures
- New endpoint
POST /fapi/v1/leverage
for changing user's initial leverage in specific symbol market. - Added "leverage" for current initial leverage and "maxNotionalValue" for notional value limit of current initial leverage in response to
GET /fapi/v1/positionRisk
. reduceOnly
now is supported in theMARKET
orders.
#
2019-10-14USDⓈ-M Futures
- Added
GET /fapi/v1/fundingRate
for getting funding fee rate history.
#
2019-10-11USDⓈ-M Futures
- Added "m" in event
ORDER_TRADE_UPDATE
in user data stream, showing if the trade is the maker side.
#
2019-10-08USDⓈ-M Futures
- New order parameter
reduceOnly
forLIMIT
orders. - New order type
TAKE_PROFIT
.