Optionalbulk_supported?: booleanWhether bulk queries are supported for this metric
Optionaldescriptors?: {Human-readable descriptors (name, tags, description)
Optionalis_pit?: booleanWhether this is a point-in-time metric
Optionalmodified?: numberWhen the metric's metadata was last updated, in unix seconds (as sent by the API, like
every other time field). undefined when the API omits it. Convert with
new Date(modified * 1000).
Optionalparameters?: Record<string, string[]>All allowed parameters of the metric and their values, keyed by parameter name (e.g.
{ a: ['BTC', 'ETH', …], i: ['24h', …] }). Optional, with no {} default: undefined when
the API omits it, so read it with ?. (e.g. meta.parameters?.a ?? []).
Optionalparameters_defaults?: Record<string, string[]>Default values of the parameters that have one, keyed by parameter name (e.g.
{ e: ['aggregated'] }: without e, the metric is served for aggregated). Only sent for
metrics with a defaulted parameter, so undefined for most metrics.
Metric path
Optionalqueried?: Record<string, any>The request's parameters as the API echoes them back (e.g. { path: '/market/price_usd_close' },
plus a when an asset was passed). Optional: undefined when the API omits it, so read it
with ?..
Optionalrefs?: {Reference links for this metric (docs, Studio, variant paths). Optional: undefined when the
API omits it, so read it with ?. (e.g. meta.refs?.docs).
Access tier required for this metric, as a non-negative integer (e.g. 2).
Type it as MetricMetadata['tier'].
Optionaltimerange?: { max: number; min: number }Available time range for this metric. Both bounds are unix timestamps in seconds
(numbers, not Dates) — convert with new Date(min * 1000).
Latest available data point, in unix seconds (number)
Earliest available data point, in unix seconds (number)
Metric metadata type