Kline (Candlesticks)
Query Kline Data
Endpoint: /v1/futures/kline
Request Parameters
Method: GET
Example
Bashcurl -X GET "https://oapi.websea.com/v1/futures/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 records to retrieve, range: [1, 2000] |
| start |
No |
int |
16745631221 |
Start timestamp |
| end |
No |
int |
16745631221 |
End timestamp |
Response Parameters
| Parameter |
Required |
Type |
Example |
Description |
| errno |
Yes |
int |
0 |
Status code |
| errmsg |
Yes |
string |
success |
Status message |
| result |
Yes |
object |
See example |
Response data |
Result Fields
| Parameter |
Required |
Type |
Example |
Description |
| ts |
Yes |
long |
1499223904680 |
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 |
Result → Data Fields
| Parameter |
Required |
Type |
Example |
Description |
| id |
Yes |
long |
1499223904680 |
Kline ID |
| amount |
Yes |
string |
37593.0266 |
Traded quantity |
| count |
Yes |
int |
1 |
Number of trades |
| open |
Yes |
string |
1935.2000 |
Open price |
| close |
Yes |
string |
1879.0000 |
Close price (for the latest kline, this is the last traded price) |
| low |
Yes |
string |
1856.0000 |
Low price |
| high |
Yes |
string |
1940.0000 |
High price |
| vol |
Yes |
string |
71031537.97866500 |
Sum of (trade price × trade 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.2000",
"close": "1879.0000",
"low": "1856.0000",
"high": "1940.0000",
"vol": "71031537.97866500"
}
]
}
}