Check Server Time
Test connectivity to the Rest API and get the current server time.
Check Server Time › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Check Server Time › Responses
Check Server Time
serverTimeserver Time
Exchange Information
Current exchange trading rules and symbol information
Exchange Information › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Exchange Information › Responses
Exchange Information
timezoneTime zone used by the server
serverTimeCurrent system time
Option contract underlying asset info
baseAssetBase currency
quoteAssetQuotation asset
underlyingName of the underlying asset of the option contract
settleAssetSettlement currency
Option asset info
nameAsset name
Option trading pair info
expiryDateexpiry time
filters
filterTypefilter Type
minPricemin Price
maxPricemax Price
tickSizetick Size
minQtyMinimum order quantity
maxQtyMaximum order quantity
stepSizestep Size
symbolTrading pair name
sideDirection: CALL long, PUT short
strikePriceStrike price
underlyingName of the underlying asset of the option contract
unitContract unit, the quantity of the underlying asset represented by a single contract.
liquidationFeeRateliquidation fee rate
minQtyMinimum order quantity
maxQtyMaximum order quantity
initialMarginInitial Magin Ratio
maintenanceMarginMaintenance Margin Ratio
minInitialMarginMin Initial Margin Ratio
minMaintenanceMarginMin Maintenance Margin Ratio
priceScaleprice precision
quantityScalequantity precision
quoteAssetQuotation asset
contractTypeContract type
underlyingTypeUnderlying type
nakedSellWhether naked selling is allowed for this symbol
statusTrading Status
rate Limits
rateLimitTyperate Limit Type
intervalinterval
intervalNuminterval Num
limitlimit
Historical Exercise Records
Get historical exercise records.
- REALISTIC_VALUE_STRICKEN -> Exercised
- EXTRINSIC_VALUE_EXPIRED -> Expired OTM
Historical Exercise Records › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Query Parameters
underlyingUnderlying asset.
startTimeStart Time, e.g 1593511200000
endTimeEnd Time, e.g 1593512200000
limitNumber of result sets returned
Historical Exercise Records › Responses
Historical Exercise Records
symbolsymbol
strikePricestrike price
realStrikePricereal strike price
expiryDateExercise time
strikeResultstrike result
Index Price
Get spot index price for option underlying.
Index Price › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Index Price › Responses
Index Price
timetime
indexPriceindex Price
Kline/Candlestick Data
Kline/candlestick bars for an option symbol. Klines are uniquely identified by their open time.
Kline/Candlestick Data › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Query Parameters
symbolOption trading pair
intervalTime interval
startTimeStart Time, e.g 1593511200000
endTimeEnd Time, e.g 1593512200000
limitNumber of result sets returned
Kline/Candlestick Data › Responses
Kline/Candlestick Data
[0]Open time
[1]Open
[2]High
[3]Low
[4]Close
[5]Volume
[6]Close time
[7]Quote asset volume
[8]Number of trades
[9]Taker buy base asset volume
[10]Taker buy quote asset volume
[11]Ignore
Open Interest
Get open interest for specific underlying asset on specific expiration date.
Open Interest › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Query Parameters
underlyingAssetUnderlying asset.
expirationexpiration date
Open Interest › Responses
Open Interest
symbolsymbol
sumOpenInterestsum Open Interest
sumOpenInterestUsdsum Open Interest Usd
timestamptimestamp
Option Mark Price
Option mark price and greek info.
Option Mark Price › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Option Mark Price › Responses
Option Mark Price
symbolsymbol
markPriceMark price
bidIVImplied volatility Buy
askIVImplied volatility Sell
markIVImplied volatility mark
deltadelta
thetatheta
gammagamma
vegavega
highPriceLimitCurrent highest buy price
lowPriceLimitCurrent lowest sell price
riskFreeInterestrisk free rate
Order Book
Check orderbook depth on specific symbol
Order Book › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
| limit | weight |
|---|---|
| 5, 10, 20, 50 | 1 |
| 100 | 5 |
| 500 | 10 |
| 1000 | 20 |
Query Parameters
symbolOption trading pair
limitDefault:100 Max:1000.Optional value:[10, 20, 50, 100, 500, 1000]
Order Book › Responses
Order Book
Bid orders. Each entry is [price, quantity].
[0]Price
[1]Quantity
Ask orders. Each entry is [price, quantity].
[0]Price
[1]Quantity
Ttransaction time
lastUpdateIdupdate id
Recent Block Trades List
Get recent block trades
Recent Block Trades List › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Query Parameters
symbolOption trading pair
limitNumber of records
Recent Block Trades List › Responses
Recent Block Trades List
idid
tradeIdtrade Id
symbolsymbol
priceprice
qtyqty
quoteQtyquote Qty
sideside
timetime
Recent Trades List
Get recent market trades
Recent Trades List › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Query Parameters
symbolOption trading pair
limitNumber of result sets returned
Recent Trades List › Responses
Recent Trades List
idid
tradeIdTradeId
symbolOption trading pair
priceCompleted trade price
qtyCompleted trade quantity
quoteQtyCompleted trade amount
sideCompleted trade direction(-1 Sell,1 Buy)
timeTime
Test Connectivity
Test connectivity to the Rest API.
Test Connectivity › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
Test Connectivity › Responses
OK
24hr Ticker Price Change Statistics
24 hour rolling window price change statistics.
24hr Ticker Price Change Statistics › Request Weight
This endpoint consumes IP-based request weight. Heavier endpoints consume more of your IP rate limit capacity.
Learn more in the Rate limits section.
1 for a single symbol; 40 when the symbol parameter is omitted
24hr Ticker Price Change Statistics › Responses
24hr Ticker Price Change Statistics
symbolsymbol
priceChange24-hour price change
priceChangePercent24-hour percent price change
lastPriceLast trade price
lastQtyLast trade amount
open24-hour open price
high24-hour high
low24-hour low
volumeTrading volume(contracts)
amountTrade amount(in quote asset)
bidPriceThe best buy price
askPriceThe best sell price
openTimeTime the first trade occurred within the last 24 hours
closeTimeTime the last trade occurred within the last 24 hours
firstTradeIdFirst trade ID
tradeCountNumber of trades
strikePriceStrike price
exercisePricereturn estimated settlement price one hour before exercise, return index price at other times