Binance Options API Interface and WebSocket
2022-09-08 09:41
Binance Options trading is available via the Binance Futures API connectivity suite and is open to users who have enabled the Binance API trading interface.
1. Market Data Endpoints
The Github link for each query will provide access to the corresponding Endpoints Weights, Parameters, and Responses.
Query | Description | Endpoint and Details |
Test Connectivity | Test connectivity to the Rest API | GET /eapi/v1/ping |
Check Server Time | Test connectivity to the Rest API and get the current server time | |
Exchange Information | Current exchange trading rules and symbol information | GET /eapi/v1/exchangeInfo |
Order Book | Get order book data | |
Recent Trades List | Get recent market trades | |
Old Trades Lookup (MARKET_DATA) | Get older market historical trades | |
Candlestick Data | Candlestick bars for an option symbol. Candles are uniquely identified by their open time | |
Options Mark Price | Options mark price and greek info | |
24hr Ticker Price Change Statistics | 24-hour rolling window price change statistics | |
Symbol Price Ticker | Get Spot Index price for the option’s underlying asset | |
Historical Exercise Records | Get historical exercise records |
2. Account/Trades Endpoints
The Github link for each query will provide access to the corresponding Endpoints Weights, Parameters, and Responses.
Query | Description | Endpoint and Details |
Options Account Information | Get current account information | GET /eapi/v1/account (HMAC SHA256) |
Funds Transfer (TRADE) | Transfer funds between the Spot and Options Wallets | |
New Order (TRADE) | Send a new order | POST /eapi/v1/order (HMAC SHA256) |
Place Multiple Orders (TRADE) | Send multiple Options orders | |
Cancel Options Order (TRADE) | Cancel an active order | |
Cancel Multiple Options Orders (TRADE) | Cancel multiple active orders | |
Cancel all Options orders on a specific symbol (TRADE) | Cancel all active orders on a symbol | |
Cancel All Options Orders by Underlying (TRADE) | Cancel all active orders on a specified underlying asset | |
Query Current Open Options Orders (USER_DATA) | Query current all open orders, status: ACCEPTED PARTIALLY_FILLED | |
Query Options Order History (TRADE) | Query all finished orders within 1 month, finished status: CANCELED FILLED REJECTED. | |
Options Position Information (USER_DATA) | Get current position information | |
Account Trade List (USER_DATA) | Get trades for a specific account and symbol | |
User Exercise Record (USER_DATA) | Get account exercise records | |
Account Funding Flow (USER_DATA) | Query account funding flows |
3. WebSocket Market Streams
You can subscribe or unsubscribe to any stream listed below by using the requests listed in the WebSocket section.
Stream | Stream Name | Description | Update Speed |
Trade Streams | The Trade Streams push raw trade information | 50ms | |
Index Stream | Underlying index stream | 1,000ms | |
Candlestick Streams | The Candlestick Streams push updates to the current candlesticks every 1,000 milliseconds (if existing) | 1,000ms | |
All Market Mini Tickers Stream | 24-hour mini ticker info for all symbols | 1,000ms | |
24-hour Ticker | 24-hour ticker info for all symbols. Only symbols whose ticker info changed will be sent | 50ms | |
New Symbol Info | New symbol listing stream | 50ms | |
Book Depth Streams | <symbol>@depth<levels> OR <symbol>@depth<levels>@500ms or <symbol>@depth<levels>@100ms | Book depth stream. Top bids and asks and valid levels are 10, 20, 50, 100, and 1,000. When levels are set to 10/20/50/100, the stream returns partial book depth. When levels are set to 1,000, the stream returns different book depths. | 100ms, 250ms, or 500ms |