get kline

API details

This API returns market candlestick (K-line) data.

get the kline of the market

get

Query parameters

MarketIdstringrequired

The market id.

TickSpaceinteger · enumrequired

The start time of the kline ticks.

Options: 1, 2, 3, 4, 5, 6, 7, 8, 9

Limitinteger · int32optional

maximum number of items to return. maximum value is 500.

Offsetinteger · int32optional

number of items to skip before starting to collect the result set.

OrderBystringoptional

the sorting parameters for the list.

see https://learn.microsoft.com/en-us/azure/search/search-query-odata-orderby#examples for the format of the OrderBy string.

supported sorting parameters are: "Timestamp".

default sorting is by " Timestamp desc".

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnetopenapi.hibit.app/v1/market/kline?MarketId=text&TickSpace=1'

200

400

401

403

404

500

501

200

text/plain

application/json

text/json

text/plain

{
  "code": 1,
  "message": "text",
  "data": {
    "items": [
      {
        "o": "text",
        "h": "text",
        "l": "text",
        "c": "text",
        "v": "text",
        "a": "text",
        "t": null
      }
    ],
    "totalCount": 1
  }
}

OK

get system timestamp

get

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://testnetopenapi.hibit.app/v1/timestamp'

200

400

401

403

404

500

501

200

text/plain

application/json

text/json

text/plain

{
  "code": 1,
  "message": "text",
  "data": {
    "timestamp": 1
  }
}

OK

Code example

import { hibitClient } from '@delandlabs/hibit-client';

const options = {
  network: HibitNetwork.Testnet
};
hibitClient.setOptions(options);

const kline = await hibitClient.getMarketKline({
  marketId: 10008n,
  tickSpace: TickSpace.OneMinute,
  limit: 100
});

SDK

Source code https://github.com/Deland-Labs/hibit-sdk