Skip to main content
GET
List entity observations

Authorizations

x-api-key
string
header
required

Query Parameters

limit
integer
default:100
Required range: 1 <= x <= 500
cursor
string
sort
string
order
enum<string>
default:asc
Available options:
asc,
desc
country
string
entity
string
entity_id
string
indicator_id
string
indicatorId
string
indicator
string

Alias of indicator_id, accepting a canonical field name, a storage indicator id, or an indicator slug. A value matching none of those returns an empty result — it is never ignored — and an empty value is rejected with 400.

source_id
string
sourceId
string
provider_id
string
providerId
string
provider
string
frequency
enum<string>
Available options:
daily,
weekly,
monthly,
quarterly,
annual,
event,
static
currency
string
type
enum<string>
Available options:
macro
numericOnly
boolean
numeric_only
boolean
importance
enum<string>
Available options:
low,
medium,
high
freshness
enum<string>

Filters by the SERIES' current freshness verdict: fresh returns rows of series whose latest print is within its cadence budget now, stale of series whose latest print has aged past it, unknown of series that cannot be assessed. Note the deliberate asymmetry with the per-row freshnessStatus field, which describes each row (a 1950 print of a healthy series computes stale as a row while its series — and therefore this filter — is fresh). Cannot be combined with as_of/since/date filters on latest routes: freshness is evaluated against now, a temporal filter against a past instant.

Available options:
fresh,
stale,
unknown
start_date
string<date>

Knowledge-time lower bound on observed_at.

end_date
string<date>

Knowledge-time upper bound on observed_at.

period
string

Period-time convenience filter: YYYY, YYYY-MM, or YYYY-Qn.

Pattern: ^\d{4}(-(0[1-9]|1[0-2]|[Qq][1-4]))?$
period_start
string<date>

Period-time lower bound on period_end.

period_end
string<date>

Period-time upper bound on period_end.

as_of
string<date-time>

Knowledge-time vintage cutoff; returns latest vintage known on or before this timestamp.

sources
enum<string>
default:preferred

How to handle a period carried by more than one data provider. 'preferred' (the default) returns one provider per (entity, indicator, frequency, period) — the publisher closest to the measurement — so a series carried by two publishers is not returned twice. 'all' returns every provider's row. A period carried by only one provider is unaffected either way, and this filter is ignored when source_id or provider_id is set.

Available options:
preferred,
all

Response

Entity observations

data
any[]
required
meta
object
required
requestId
string
required