K-line data
Description
Returns up to 1000 candles for a token (USDT pairs only) in a time range.
Use cases
- Multi-interval OHLCV
- Timing entries/exits with price action
Update frequency: Depends on bucketType
Endpoint
- Method:
POST - Path:
/open/v1/trade/kline/getTradeKLineList
Credits
- Cost:
1
Prerequisites
vsTokenId
| Case | Note | How |
|---|---|---|
| Known | Cache | Context |
| Unknown | POST /vs-token/list | Pre-call |
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
| vsTokenId | long | Yes | Token id |
| bucketType | string | Yes | Interval code |
| startTime | long | No | Start (ms) |
| endTime | long | Yes | End (ms) |
| size | integer | No | Rows; default 360, max 1000 |
bucketType
| Value | Interval |
|---|---|
| 5m | 5 minutes |
| 15m | 15 minutes |
| 30m | 30 minutes |
| 1h | 1 hour |
| 4h | 4 hours |
| 1d | 1 day |
| 1w | 1 week |
Response — data
| Field | Type | Serialized | Description |
|---|---|---|---|
| vsTokenId | long | string | Token id |
| symbol | string | string | Ticker |
| name | string | string | Name |
| klineType | string | string | Venue/type code |
| klineData | array | array | Candles |
| time | long | long | Open time (ms) |
| open | number | string | Open |
| close | number | string | Close |
| high | number | string | High |
| low | number | string | Low |
| volume | number | string | Base volume |
| amount | number | string | Quote volume (USD) |
Semantics
| Field | Meaning | Tip |
|---|---|---|
| volume | Base volume | Activity |
| amount | USD notional | With volume → implied VWAP |
Example
json
{
"vsTokenId": 1,
"bucketType": "5m",
"endTime": 1773478632535,
"size": 20
}cURL (Linux/macOS)
bash
curl --location --request POST 'http://${host}/api/open/v1/trade/kline/getTradeKLineList' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: xxxxx' \
--header 'X-TIMESTAMP: xxxxx' \
--header 'X-SIGN: xxxxx' \
--header 'Accept: */*' \
--data-raw '{
"vsTokenId": 1,
"bucketType": "5m",
"endTime": 1773478632535,
"size": 20
}'cURL (Windows CMD)
cmd
curl --location --request POST "http://${host}/api/open/v1/trade/kline/getTradeKLineList" ^
--header "Content-Type: application/json" ^
--header "X-API-KEY: xxxxx" ^
--header "X-TIMESTAMP: xxxxx" ^
--header "X-SIGN: xxxxx" ^
--header "Accept: */*" ^
--data-raw "{ \"vsTokenId\": 1, \"bucketType\": \"5m\", \"endTime\": 1773478632535, \"size\": 20}"Sample success
json
{
"code": 200,
"message": "success",
"data": {
"vsTokenId": "1",
"symbol": "BTC",
"name": "Bitcoin",
"klineType": "01",
"klineData": [
{
"time": 1773478200000,
"open": "70544.92",
"close": "70594.48",
"high": "70594.49",
"low": "70536.58",
"volume": "20.543779999999995",
"amount": "1449509.9399093997"
}
]
},
"requestId": "xxx-xxx-xxx"
}