Skip to content

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

CaseNoteHow
KnownCacheContext
UnknownPOST /vs-token/listPre-call

Request body (JSON)

FieldTypeRequiredDescription
vsTokenIdlongYesToken id
bucketTypestringYesInterval code
startTimelongNoStart (ms)
endTimelongYesEnd (ms)
sizeintegerNoRows; default 360, max 1000

bucketType

ValueInterval
5m5 minutes
15m15 minutes
30m30 minutes
1h1 hour
4h4 hours
1d1 day
1w1 week

Response — data

FieldTypeSerializedDescription
vsTokenIdlongstringToken id
symbolstringstringTicker
namestringstringName
klineTypestringstringVenue/type code
klineDataarrayarrayCandles
  timelonglongOpen time (ms)
  opennumberstringOpen
  closenumberstringClose
  highnumberstringHigh
  lownumberstringLow
  volumenumberstringBase volume
  amountnumberstringQuote volume (USD)

Semantics

FieldMeaningTip
volumeBase volumeActivity
amountUSD notionalWith 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"
}