Skip to main content
GET

Authorizations

api_key
string
query
required

Coin Metrics API key can be specified as ?api_key= query parameter.

Query Parameters

indexes
string[]
required

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

Example:

"CMBIBE"

frequency
string
default:1d

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

granularity
string
default:raw

Downsampling granularity for the data of a given native frequency. Granularity applied to external indexes only. Ignored for the indexes calculated by Coin Metrics. Possible values are raw, 1m, 1h, 1d-ny-close, 1d-ny-close-last-second, 1d-ldn-close, 1d-ldn-close-last-second, 1d-sg-close, 1d-sg-close-last-second, or custom offsets (e.g., 1d-16:00). For external indexes with a granularity coarser than raw, each returned record is the last observation within a granularity interval, and time is the timestamp of that observation rather than the interval boundary. Intervals with no observations are omitted from the response. Because an interval is matched against the requested range by its boundary, the observation selected for the interval containing start_time can have a time earlier than start_time, by less than one granularity interval.

start_time
string

Start of the time interval.
This field refers to the time field in the response.
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.
Inclusive by default.
UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.
If start_time is omitted, response will include time series from the earliest time available.

end_time
string

End of the time interval.
This field refers to the time field in the response.
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.
Inclusive by default.
UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.
If end_time is omitted, response will include time series up to the latest time available.

start_inclusive
boolean
default:true

Inclusive or exclusive corresponding start_* parameters.

end_inclusive
boolean
default:true

Inclusive or exclusive corresponding end_* parameters.

timezone
string
default:UTC

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

Example:

"America/New_York"

page_size
integer<int32>
default:100

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

Required range: 1 <= x <= 10000
paging_from
enum<string>
default:end

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

Available options:
start,
end
limit_per_index
integer<int32>

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

include_verification
boolean
default:false

If set to true, includes information about verification.

pretty
boolean
default:false

Human-readable formatting of JSON responses.

format
enum<string>
default:json

Format of the response. Supported values are json, json_stream, csv.

Available options:
json,
json_stream,
csv
next_page_token
string

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

Response

Time series of index levels.

data
object[]
required
next_page_token
string

Token of the next page results for a given request.

next_page_url
string

URL of the next page results for a given request.