Market Data Endpoints
Check Server Time
GET /api/v1/time
Test connectivity to the Rest API and get the current server time.
Weight: 1
Parameters:
NONE
Response:
{
"serverTime": 1538323200000
}Exchange Information
GET /api/v1/exchangeInfo
Current exchange trading rules and symbol information
Weight:1
Parameters:
NONE
Response
{
"timezone": "UTC",
"brokerFilters": [],
"symbols": [ // spot symbols
{
"filters":[
{
"minPrice":"0.01",
"maxPrice":"100000.00000000",
"tickSize":"0.01",
"filterType":"PRICE_FILTER"
},
{
"minQty":"0.0001", // min trade quantity
"maxQty":"4000", // max trade quantity
"stepSize":"0.0001",
"filterType":"LOT_SIZE"
},
{
"minNotional":"10",
"filterType":"MIN_NOTIONAL"
},
{
"minAmount": "10", // minimum transaction amount
"maxAmount": "6600000", // maximum trade amount
"minBuyPrice": "0.01", // minimum buy price
"filterType": "TRADE_AMOUNT"
},
{
"maxSellPrice": "999999999", // limit max sell price
"buyPriceUpRate": "0.1", // maximum sell price
"sellPriceDownRate": "0.1", // maximum sell price
"sellPriceDownRate": "0.1", // the maximum sell price of the limit
"maxEntrustNum": "100000", // the maximum number of orders (contracts)
"maxConditionNum": "100000", // maximum number of condition orders (contracts)
"filterType": "LIMIT_TRADING"
},
{
"buyPriceUpRate": "0.1", // Buy cannot be higher than 10% of the marked (contract)/latest (spot) price
"sellPriceDownRate": "0.1", // Sell cannot be less than 10% of the marked (contract)/latest (spot) price
"filterType": "MARKET_TRADING"
},
{
"noAllowMarketStartTime": "0", // Market order start time is not allowed
"noAllowMarketEndTime": "0", // Do not allow the market order end time
"limitOrderStartTime": "0", // the start time of a limit order
"limitOrderEndTime": "0", // Limit order end time
"limitMinPrice": "0", // the minimum price of a limit order
"limitMaxPrice": "0", // the maximum price of the limit order
"filterType": "OPEN_QUOTE"
}
],
"exchangeId": "301",
"symbol": "ETHUSDT",
"symbolName": "ETHUSDT",
"status": "TRADING",
"baseAsset": "ETH",
"baseAssetName": "ETH",
"baseAssetPrecision": "0.0001",
"quoteAsset": "USDT",
"quoteAssetName": "USDT",
"quotePrecision": "0.01",
"icebergAllowed": false,
"isAggregate": false,
"allowMargin": true
}
],
"rateLimits": [
{
"rateLimitType": "REQUEST_WEIGHT",
"interval": "MINUTE",
"intervalUnit": 1,
"limit": 3000
},
{
"rateLimitType": "ORDERS",
"interval": "SECOND",
"intervalUnit": 60,
"limit": 60
}
],
"options": [],
"contracts": [ // Futures(contracts) symbols
{
"filters":[
{
"minPrice":"0.01",
"maxPrice":"100000.00000000",
"tickSize":"0.01",
"filterType":"PRICE_FILTER"
},
{
"minQty":"0.0001", // min trade quantity, token quantity not contracts
"maxQty":"4000", // max trade quantity, token quantity not contracts
"stepSize":"0.0001",
"filterType":"LOT_SIZE"
},
{
"minNotional":"10",
"filterType":"MIN_NOTIONAL"
},
{
"minAmount": "10", // minimum transaction amount
"maxAmount": "6600000", // maximum trade amount
"minBuyPrice": "0.01", // minimum buy price
"filterType": "TRADE_AMOUNT"
},
{
"maxSellPrice": "999999999", // limit max sell price
"buyPriceUpRate": "0.1", // maximum sell price
"sellPriceDownRate": "0.1", // maximum sell price
"sellPriceDownRate": "0.1", // the maximum sell price of the limit
"maxEntrustNum": "100000", // the maximum number of orders (contracts)
"maxConditionNum": "100000", // maximum number of condition orders (contracts)
"filterType": "LIMIT_TRADING"
},
{
"buyPriceUpRate": "0.1", // Buy cannot be higher than 10% of the marked (contract)/latest (spot) price
"sellPriceDownRate": "0.1", // Sell cannot be less than 10% of the marked (contract)/latest (spot) price
"filterType": "MARKET_TRADING"
},
{
"noAllowMarketStartTime": "0", // Market order start time is not allowed
"noAllowMarketEndTime": "0", // Do not allow the market order end time
"limitOrderStartTime": "0", // the start time of a limit order
"limitOrderEndTime": "0", // Limit order end time
"limitMinPrice": "0", // the minimum price of a limit order
"limitMaxPrice": "0", // the maximum price of the limit order
"filterType": "OPEN_QUOTE"
}
],
"exchangeId": "301",
"symbol": "BTC-SWAP-USDT",
"symbolName": "BTC-SWAP-USDTUSDT",
"status": "TRADING",
"baseAsset": "BTC-SWAP-USDT",
"baseAssetPrecision": "1",
"quoteAsset": "USDT",
"quoteAssetPrecision": "0.1",
"icebergAllowed": false,
"inverse": false,
"index": "BTCUSDT",
"marginToken": "USDT",
"marginPrecision": "0.0001",
"contractMultiplier": "0.0001",
"underlying": "BTC",
"riskLimits": [
{
"riskLimitId": "200000133",
"quantity": "1000000.0",
"initialMargin": "0.01",
"maintMargin": "0.005"
},
{
"riskLimitId": "200000134",
"quantity": "2000000.0",
"initialMargin": "0.02",
"maintMargin": "0.01"
},
{
"riskLimitId": "200000135",
"quantity": "3000000.0",
"initialMargin": "0.03",
"maintMargin": "0.015"
},
{
"riskLimitId": "200000136",
"quantity": "4000000.0",
"initialMargin": "0.04",
"maintMargin": "0.02"
}
]
},
{
"filters":[
{
"minPrice":"0.01",
"maxPrice":"100000.00000000",
"tickSize":"0.01",
"filterType":"PRICE_FILTER"
},
{
"minQty":"0.0001",
"maxQty":"4000",
"stepSize":"0.0001",
"filterType":"LOT_SIZE"
},
{
"minNotional":"10",
"filterType":"MIN_NOTIONAL"
},
{
"minAmount": "10", // minimum transaction amount
"maxAmount": "6600000", // maximum trade amount
"minBuyPrice": "0.01", // minimum buy price
"filterType": "TRADE_AMOUNT"
},
{
"maxSellPrice": "999999999", // limit max sell price
"buyPriceUpRate": "0.1", // maximum sell price
"sellPriceDownRate": "0.1", // maximum sell price
"sellPriceDownRate": "0.1", // the maximum sell price of the limit
"maxEntrustNum": "100000", // the maximum number of orders (contracts)
"maxConditionNum": "100000", // maximum number of condition orders (contracts)
"filterType": "LIMIT_TRADING"
},
{
"buyPriceUpRate": "0.1", // Buy cannot be higher than 10% of the marked (contract)/latest (spot) price
"sellPriceDownRate": "0.1", // Sell cannot be less than 10% of the marked (contract)/latest (spot) price
"filterType": "MARKET_TRADING"
},
{
"noAllowMarketStartTime": "0", // Market order start time is not allowed
"noAllowMarketEndTime": "0", // Do not allow the market order end time
"limitOrderStartTime": "0", // the start time of a limit order
"limitOrderEndTime": "0", // Limit order end time
"limitMinPrice": "0", // the minimum price of a limit order
"limitMaxPrice": "0", // the maximum price of the limit order
"filterType": "OPEN_QUOTE"
}
],
"exchangeId": "301",
"symbol": "BTC-SWAP",
"symbolName": "BTC-SWAP",
"status": "TRADING",
"baseAsset": "BTC-SWAP",
"baseAssetPrecision": "1",
"quoteAsset": "USDT",
"quoteAssetPrecision": "0.1",
"icebergAllowed": false,
"inverse": true,
"index": "BTCUSDT",
"marginToken": "BTC",
"marginPrecision": "0.00000001",
"contractMultiplier": "1.0",
"underlying": "BTC",
"riskLimits": [
{
"riskLimitId": "200000137",
"quantity": "1000000.0",
"initialMargin": "0.01",
"maintMargin": "0.005"
},
{
"riskLimitId": "200000138",
"quantity": "2000000.0",
"initialMargin": "0.02",
"maintMargin": "0.01"
},
{
"riskLimitId": "200000139",
"quantity": "3000000.0",
"initialMargin": "0.03",
"maintMargin": "0.015"
},
{
"riskLimitId": "200000140",
"quantity": "4000000.0",
"initialMargin": "0.04",
"maintMargin": "0.02"
}
]
}
],
"coins": [
{
"orgId": "9001",
"coinId": "ETH",
"coinName": "ETH",
"coinFullName (tokenFullName)": "Ethereum",
"allowWithdraw": true,
"allowDeposit": true,
"chainTypes": []
},
{
"orgId": "9001",
"coinId": "USDT",
"coinName": "USDT",
"coinFullName (tokenFullName)": "TetherUS",
"allowWithdraw": true,
"allowDeposit": true,
"chainTypes": [
{
"chainType": "ERC20",
"withdrawFee": "0.1",
"minWithdrawQuantity": "10",
"maxWithdrawQuantity": "1000",
"minDepositQuantity": "1",
"allowDeposit": true,
"allowWithdraw": true
},
{
"chainType": "TRC20",
"withdrawFee": "0.1",
"minWithdrawQuantity": "10",
"maxWithdrawQuantity": "1000",
"allowDeposit": true,
"allowWithdraw": true
},
{
"chainType": "OMNI",
"withdrawFee": "0.1",
"minWithdrawQuantity": "10",
"maxWithdrawQuantity": "1000",
"allowDeposit": true,
"allowWithdraw": true
}
]
},
{
"orgId": "9001",
"coinId": "BTC",
"coinName": "BTC",
"coinFullName": "Bitcoin",
"allowWithdraw": false,
"allowDeposit": false,
"chainTypes": []
},
{
"orgId": "9001",
"coinId": "UNI",
"coinName": "UNI",
"coinFullName": "uniswap",
"allowWithdraw": false,
"allowDeposit": false,
"chainTypes": []
},
{
"orgId": "9001",
"coinId": "XRP",
"coinName": "XRP",
"coinFullName (tokenFullName)": "XRP",
"allowWithdraw": false,
"allowDeposit": false,
"chainTypes": []
},
{
"orgId": "9001",
"coinId": "EOS",
"coinName": "EOS1",
"coinFullName (tokenFullName)": "EOS",
"allowWithdraw": true,
"allowDeposit": true,
"chainTypes": []
},
{
"orgId": "9001",
"coinId": "JET",
"coinName": "JET",
"coinFullName (tokenFullName)": "JET",
"allowWithdraw": false,
"allowDeposit": false,
"chainTypes": []
}
]
}status Field Description:
For spot trading pairs (pairs in the symbols array), possible values of status:
| Status Value | Description |
|---|---|
| TRADING | Trading |
| ONLINE | Online (not tradable) |
| OFFLINE | Offline (trading pair has been delisted) |
| API_TRADE_FORBIDDEN | API trading forbidden (trading via API is prohibited) |
For contract trading pairs (pairs in the contracts array), possible values of status:
| Status Value | Description |
|---|---|
| TRADING | Trading |
| ONLINE | Online (not tradable) |
| API_TRADE_FORBIDDEN | API trading forbidden (trading via API is prohibited) |
| OPEN_FORBIDDEN | Opening forbidden (opening positions is forbidden, but closing is allowed) |
| CLOSE_FORBIDDEN | Closing forbidden (closing positions is forbidden, but opening is allowed) |
Order Book
GET /quote/v1/depth
Weight:
Adjusted based on the limit:
| Limit | Weight |
|---|---|
| 5, 10, 20, 50, 100 | 1 |
| 500 | 5 |
| 1000 | 10 |
Response:
{
"t": 1768300458706,//Matching time
"b": [
[
"3.90000000", // price
"431.00000000" // quantity
],
[
"4.00000000",
"431.00000000"
]
],
"a": [
[
"4.00000200", // price
"12.00000000" // quantity
],
[
"5.10000000",
"28.00000000"
]
]
}Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
| limit | INT | NO | Default 100; |
Notes:If limit=0 is set, a lot of data will be returned.
Merge Depth
GET /quote/v1/depth/merged
Merged deep interface.
Weight:1
Response
{
"t": 1672035413265,//time
"b": [//Buy Depth High to Low
[
"16851.95",//price
"0.003321"//quantity
],
[
"16851.87",
"0.005456"
],
[
"16851.47",
"0.002219"
]
],
"a": [//Sell Depth Low to High
[
"16870.19",
"0.003838"
],
[
"16873.05",
"0.00361"
],
[
"16873.06",
"0.002623"
]
]
}Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
| scale | INT | NO | Gears: 0,1,2,3,4,5 For example: 0means gear 1, 1 means gear 2 |
| limit | INT | NO |
Recent Trades List
GET /quote/v1/trades
Get recent market trades
Weight:1
Response:
[
{
"p": "4.00000100",
"q": "12.00000000",
"t": 1499865549590,
"ibm": true // Transaction direction isBuyerMaker
}
]Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
| limit | INT | NO | Default 60; Max 60 |
Kline/Candlestick Data
GET /quote/v1/klines
Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.
Weight:1
Response:
[
[
1499040000000, // Open time
"0.01634790", // Open price
"0.80000000", // High price
"0.01575800", // Low price
"0.01577100", // Close price
"148976.11427815", // Volume
1499644799999, // Close time
"2434.19055334", // Quote asset volume
308, // Number of trades
"1756.87402397", // Taker buy base asset volume
"28.46694368" // Taker buy quote asset volume
]
]Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
| interval | ENUM | YES | interval |
| startTime | LONG | NO | start timestamp |
| endTime | LONG | NO | en d timestamp |
| limit | INT | NO | Default 1000; Max 1000 |
Notes: If startTime and endTime are not sent, only the latest K line will be returned.
Index Price Kline/Candlestick Data
GET /quote/v1/index/klines
Kline/candlestick bars for the index price of a pair.
Response:
{
"code": 200,
"data": [
{
"t": 1669155300000,//time
"s": "BTCUSDT",// symbol
"sn": "BTCUSDT",//symbol name
"c": "1127.1",//Close price
"h": "1130.81",//High price
"l": "1126.17",//Low price
"o": "1130.8",//Open price
"v": "0",//Volume
"st": 1669156800000 //interface response time
},
{
"t": 1669156200000,
"s": "ETHUSDT",
"sn": "ETHUSDT",
"c": "1129.44",
"h": "1129.54",
"l": "1127.1",
"o": "1127.1",
"v": "0",
"st": 1669156800000
}
]
}Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
| interval | ENUM | YES | interval |
| from | LONG | YES | start timestamp |
| to | LONG | YES | end timestamp |
| limit | INT | NO | limit, DEFAULT:2000 MAX:2000 |
Get Index Price Components
GET /quote/v1/indexPriceComponents
get the index components of one symbol
Response:
{
"index": "91429.02891304", //Last price of the index
"edp": "91408.35002101", //last 10 minutes average index price
"components": [
{
"exchange": "BITGET", //Name of the exchange
"spotPair": "BTCUSDT",//Spot trading pair on the exchange (e.g., BTCUSDT)
"weight": "1.0" //Weight in the index calculation
},
{
"exchange": "KUCOIN",
"spotPair": "BTCUSDT",
"weight": "1.0"
},
{
"exchange": "COINBASE",
"spotPair": "BTCUSDT",
"weight": "1.0"
},
{
"exchange": "MEXC",
"spotPair": "BTCUSDT",
"weight": "1.0"
},
{
"exchange": "BYBIT",
"spotPair": "BTCUSDT",
"weight": "1.0"
},
{
"exchange": "OKEX",
"spotPair": "BTCUSDT",
"weight": "1.0"
},
{
"exchange": "BINANCE",
"spotPair": "BTCUSDT",
"weight": "1.0"
}
],
"time": 1768277194000 //Timestamp of the last update in milliseconds
}Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | Index name, like BTCUSDT |
Mark Price Kline/Candlestick Data
GET /quote/v1/markPrice/klines
Kline/candlestick bars for the mark price of a symbol.
Response:
{
"code": 200,
"data": [
{
"symbol": "BTC-SWAP-USDT",// Symbol
"time": 1670157900000,// time
"low": "16991.14096",//Low price
"open": "16991.78288",//Open price
"high": "16996.30641",// High prce
"close": "16996.30641",// Close price
"volume": "0",// Volume
"curId": 1670157900000,
"klineType": "1m", // kline type,such as 1m,5m....
"change": "0.0008" //(index price-mark price)/mark price
}
]
}Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
| interval | ENUM | YES | interval |
| from | LONG | YES | start timestamp |
| to | LONG | YES | end timestamp |
| limit | INT | NO | limit,DEFAULT 2000 MAX 2000 |
Mark Price
GET /quote/v1/markPrice
Get the mark price of a trading pair.
Response:
{
"exchangeId": 301,
"symbolId": "BTC-SWAP-USDT",// Symbol
"price": "17042.54471",// Mark price
"time": 1670897454000// time
}Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
Funding Rate
GET /api/v1/futures/fundingRate
Response:
[
{
"symbol": "BTC-SWAP-USDT", // Symbol
"nextFundingTime": "1668427200000", //Next fund fee settlement time
"rate": "0.0018099173553719" //The settlement funding rate.
}
]Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | NO | symbol |
Get Funding Rate History
GET /api/v1/futures/historyFundingRate
Response:
[
{
"id": "3434343434343",
"symbol": "BTC-SWAP-USDT", // Symbol
"settleTime": "1570708800000", //Funding rate settlement time
"settleRate": "0.00321" //Funding rate
}
]Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
| fromId | LONG | NO | start id |
| endId | LONG | NO | end id |
| limit | INT | NO | Default 20 Min 1 Max 1000 |
Get Open Interest
GET /quote/v1/openInterest
Get the total positions of a certain trading pair on the platform
Response:
{
"openInterestList": [
{
"size": "88059.96", //Total open interest of the platform Specific coins, eg.: ETH in ETHUSDT
"symbol": "ETH-SWAP-USDT" //Trading pair name
}
]
}Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
Long/Short Ratio
GET /quote/v1/globalLongShortAccountRatio
Query symbol Long/Short Ratio
Response:
[
{
"symbol": "BTC-SWAP-USDT",
"timeStamp": 1768271400000,
"longShortRatio": "2.7432", // long/short account num ratio of all traders
"longAccount": "0.7329", //long account num ratio of all traders
"shortAccount": "0.2671" // short account num ratio of all traders
}
]Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | symbol |
| period | STRING | YES | "5m","15m","30m","1h","2h","4h","6h","12h","1d" |
| limit | LONG | NO | default 30, max 500 |
| startTime | LONG | NO | |
| endTime | LONG | NO |
note:If startTime and endTime are not sent, the most recent data is returned. Only the data of the latest 30 days is availab
Get Insurance fund
GET /api/v1/futures/insuranceBySymbol
query the insurance fund balance of a certain trading pair
Response:
{
"list": [
{
"coin": "USDT", //Coin
"symbol": "BTC-SWAP-USDT", //contracts symbol
"value": "4271010.26212436", //USD value
"updateTime": "1768262400000" //Data updated time (ms)
},
{
"coin": "USDT",
"symbol": "BTC-SWAP-USDT",
"value": "4271013.74008353",
"updateTime": "1768176000000"
}
]
}Data updated time (ms)
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbolId | STRING | YES | symbol |
note:The system returns 14 days of data by default, updated daily at 00:00 UTC.
Get All Risk Limit Configuration List
GET /api/v1/futures/riskLimits
Get all risk limit configuration list for the specified trading pair (only returns non-whitelist risk limits).
Weight:1
Response:
[
{
"level": 1, // Risk level, sorted by quantity, starting level is 1
"quantity": "1000000.0", // Quantity
"maintainMargin": "0.005", // Maintenance margin rate
"initialMargin": "0.01", // Initial margin rate
"maxLeverage": 100 // Maximum leverage
},
{
"level": 2,
"quantity": "2000000.0",
"maintainMargin": "0.01",
"initialMargin": "0.02",
"maxLeverage": 50
}
]Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | YES | Trading pair |
24hr Ticker Price Change Statistics
GET /quote/v1/contract/ticker/24hr
24 hour rolling window price change statistics. Careful when accessing this with no symbol.
Weight:
1 for a single symbol; 40 when the symbol parameter is omitted
Response:
[
{
"t": 1538725500422, // time
"a": "1.10000000", // highest selling price
"b": "1.00000000", // highest bid
"s": "BTC-SWAP-USDT", // symbol
"c": "4.00000200", // latest transaction price
"o": "99.00000000", // open price
"h": "100.00000000", // high price
"l": "0.10000000", // low price
"v": "8913.30000000", // Base asset volume
"qv": "15.30000000", // otal trade volume (in quote asset)
"pc": "15.30000000", // priceChange
"pcp": "15.30000000" // priceChangePercent
}
]Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | NO | symbol |
| realtimeInterval | ENUM | NO | 24h,1d,1d+8 |
- If the symbol is not sent, tickers for all symbols will be returned in an array.
Symbol Price Ticker
GET /quote/v1/contract/ticker/price
Latest price for a symbol or symbols.
Weight:1
Response:
[
{
"s": "BTC-SWAP-USDT", // Symbol
"p": "4.00000200" // Latest price
}
]Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | NO | symbol |
- If the symbol is not sent, tickers for all symbols will be returned in an array.
Symbol Index Price
GET /quote/v1/index
Index price for a symbol or symbols.
Weight:1
Response:
{
"index":{
"BTCUSDT":"42999.21" // index price
},
"edp":{
"BTCUSDT":"43031.36006" // Average of indices over 10 minutes
}
}Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | NO | symbol |
- If the symbol is not sent, tickers for all symbols will be returned in an array.
Symbol Order Book Ticker
GET /quote/v1/contract/ticker/bookTicker
Best price/qty on the order book for a symbol or symbols.
Weight:1
Response:
[
{
"t": 1535975085052, // Time
"s": "BTC-SWAP-USDT", // Symbol
"b": "4.00000000", // bidPrice
"bq": "431.00000000", // bidQty
"a": "4.00000200", // askPrice
"aq": "9.00000000" // askQty
}
]Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| symbol | STRING | NO | symbol |
- If the symbol is not sent, bookTickers for all symbols will be returned in an array.