1. Market Data Endpoints
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 | |
Kline/Candlestick Data | Kline/candlestick bars for an option symbol. Klines 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 | |
Open Interest | Get open interest for an underlying asset on a specific expiration date |
2. Account/Trades Endpoints
Query | Description | Endpoint and Details |
Option Account Information (TRADE) | Get current account information | GET /eapi/v1/account (HMAC SHA256) |
Funds Transfer (TRADE) | View more details here | |
New Order (TRADE) | Send a new order | POST /eapi/v1/order (HMAC SHA256) |
Place Multiple Orders (TRADE) | Send multiple Options orders | |
Query Single Order (TRADE) | Check an order’s status | |
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 5 days. Order status: CANCELLED, 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
Stream | Stream Name | Description | Update Speed |
Trade Streams | <symbol>@trade or <underlyingAsset>@trade | The Trade Streams push raw trade information for a specific symbol or an underlying asset. e.g., ETH@trade | 50ms |
Index Stream | The underlying (e.g., ETHUSDT) index stream | 1,000ms | |
Mark Price | The mark price for all option symbols on a specific underlying asset. e.g., ETH@markPrice | 1,000ms | |
Kline/Candlestick Streams | The Kline/Candlestick Stream push updates to the current kline/candlestick every 1,000 milliseconds (if existing) | 1,000ms | |
24-hour Ticker | 24-hour ticker info for all symbols. Only symbols whose ticker info changed will be sent | 1,000ms | |
24-hour Ticker by underlying asset and expiration date | 24-hour ticker info by underlying asset and expiration date. e.g., ETH@ticker@220930 | 1,000ms | |
Open Interest | Option open interest for an underlying asset on a specific expiration date. e.g. ETH@openInterest@221125 | 60s | |
New Symbol Info | New symbol listing stream | 50ms | |
Partial Book Depth Streams | <symbol>@depth<levels> or <symbol>@depth<levels>@100ms or <symbol>@depth<levels>@1000ms | Top bids and asks. Valid levels are 10, 20, 50, 100 | 100ms, 500ms, or 1,000ms, (default when update speed isn't used) |
Diff. Book Depth Streams | When the depth level is set to 1,000, the stream returns different book depth pushes every 50ms. Please follow the subsequent instructions on how to manage a local order book correctly | 50ms |
4. WebSocket User Data Streams
Event | Event Type | Description | Update Speed |
Account Data | Update under the following conditions:
| 50ms | |
Order Update | Update under the following conditions:
| 50ms |