Skip to content

Query Kline (Candlestick) Data

Endpoint: /v1/spot/kline

Request Method

GET

Example

Bash
curl -X GET "https://oapi.websea.com/v1/spot/kline?symbol=BTC-USDT&period=1min&size=150"

Query Parameters

Parameter Required Type Example Description
symbol Yes string BTC-USDT Trading pair
period Yes string 1min Kline interval: 1min, 5min, 15min, 30min, 1hour, 6hour, 12hour, 1day, 1week
size No int 150 Number of klines to retrieve. Range: [1, 2000]

Response Parameters

Parameter Required Type Example Description
errno Yes int 0 Status code
errmsg Yes string success Status message
result Yes object See example Result data

Result Fields

Parameter Required Type Example Description
ts Yes int 1499184000 Data timestamp
symbol Yes string BTC-USDT Trading pair
period Yes string 1min Kline interval: 1min, 5min, 15min, 30min, 60min, 1day, 1mon, 1week, 1year
data Yes array See example Kline data

Data Fields

JSON
"data": [
  {
    "id": "Kline ID",
    "amount": "Trading volume (base currency)",
    "count": "Number of trades",
    "open": "Open price",
    "close": "Close price (for the latest kline, this is the latest trade price)",
    "low": "Lowest price",
    "high": "Highest price",
    "vol": "Trading volume (quote currency), calculated as sum(price * quantity)"
  }
]

Response Example

JSON
{
    "errno": 0,
    "errmsg": "success",
    "result": {
        "symbol": "EOS-USDT",
        "period": "1min",
        "ts": "1499223904680",
        "data": [
            {
                "id": 1499184000,
                "amount": 37593.0266,
                "count": 0,
                "open": 1935.2,
                "close": 1879,
                "low": 1856,
                "high": 1940,
                "vol": 71031537.978665
            }
        ]
    }
}
JSON
{
    "errno": 10010,
    "errmsg": "failed"
}