v1

latestOpenAPI 3.0.2Apache 2.02026-07-17189642856.1 KB
Timeseries

Index levels

Returns levels for specified indexes.<br/> Results are ordered by tuple (index, time).<br/> To fetch the next page of results use next_page_url JSON response field.

get/timeseries/index-levels

Query parameters

indexesstring[] required

Comma separated list of indexes, or patterns like CMBI*, or *BTC.<br/> Use the /catalog-all-v2/index-levels endpoint for the full list of supported indexes.

frequencystring

Frequency of the index. Supported values are 1s, 15s, 1h, 1d-ny-close, 1d-sg-close, 1d, 1d-HH:00.<br/> Use the /catalog-all-v2/index-levels endpoint for the full list of supported frequencies per index.

start_timestring

Start of the time interval.<br/> This field refers to the time field in the response.<br/> Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120.<br/> Inclusive by default.<br/> UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.<br/> If start_time is omitted, response will include time series from the earliest time available.

end_timestring

End of the time interval.<br/> This field refers to the time field in the response.<br/> Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120.<br/> Inclusive by default.<br/> UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.<br/> If end_time is omitted, response will include time series up to the latest time available.

start_inclusiveboolean

Inclusive or exclusive corresponding start_* parameters.

end_inclusiveboolean

Inclusive or exclusive corresponding end_* parameters.

timezonestring
Example:America/New_York

Timezone name for start_time and end_time timestamps.<br/> This parameter does not modify the output times, which are always UTC.<br/> Format is defined by TZ database.

page_sizeinteger

Number of items per single page of results.<br/> The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

paging_from'start' | 'end' PagingFrom

Where does the first page start, at the start of the interval or at the end.<br/> The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

limit_per_indexinteger

How many entries per index result should contain. It is useful when multiple indexes are requested.

include_verificationboolean

If set to true, includes information about verification.

prettyboolean

Human-readable formatting of JSON responses.

format'json' | 'csv'

Format of the response.

next_page_tokenstring

Token for receiving the results from the next page of a query.<br/> Should not be used directly. To iterate through pages just use next_page_url response field.

Response

Time series of index levels.

next_page_tokenstring

Token of the next page results for a given request.

next_page_urlstring

URL of the next page results for a given request.