/ecb/datasets

POST /api/ecb/datasets

Price: 1 credit

Get multiple ECB time series from a dataset, sliced by dimension filters

How to use it

Fetch several European Central Bank time series at once from a single dataset (e.g. EXR for exchange rates, BSI for monetary aggregates, ICP for consumer prices). Slice the dataset with either a dot-separated key (empty segments match all values, + joins alternatives) or a filters mapping of dimension id to value codes. Each returned series has its resolved title, dimensions and observations. Look up dimension ids and value codes via the datasets/dimensions endpoint; an unfiltered dataset can contain a very large number of series.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• dataset string required — Dataset code (examples: "EXR", "BSI", "ICP", "FM")
• count integer required — Number of series to return (min: 1)
• key string nullable — Dot-separated dimension key with optional wildcards; empty segments match all values (examples: "D.USD.EUR.SP00.A", "D.USD+JPY.EUR.SP00.A", "D..EUR.SP00.A")
• filters object nullable — Dimension filters as a mapping of dimension id to allowed value codes; used to build the key when key is not given (examples: {"CURRENCY":["USD","JPY"],"CURRENCY_DENOM":["EUR"],"FREQ":["D"]})
  • * array
• start_period string nullable — Earliest time period, inclusive (examples: "2020", "2020-03", "2020-Q1")
• end_period string nullable — Latest time period, inclusive (examples: "2024", "2024-12", "2024-Q4")

Response

• @type string (default: "EcbSeries")
• key string required
• title_complement string nullable
• unit string nullable
• unit_label string nullable
• unit_mult integer nullable
• decimals integer nullable
• collection string nullable
• source_agency string nullable
• time_format string nullable
• dimensions array required
  • @type string (default: "EcbDimensionValue")
  • id string required
  • code string required
  • label string nullable
• observations array required
  • @type string (default: "EcbObservation")
  • period string required
  • value number nullable
  • obs_status string nullable
  • obs_status_label string nullable
  • obs_conf string nullable
  • obs_conf_label string nullable
  • obs_pre_break string nullable
  • obs_com string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Dataset not found or no series for the requested slice Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.