/ecb/series

POST /api/ecb/series

Price: 1 credit

Get a single ECB time series by its full key, with observations and metadata

How to use it

Fetch one European Central Bank time series by its full key (e.g. EXR.D.USD.EUR.SP00.A for the daily US dollar / euro reference exchange rate, ICP.M.U2.N.000000.4.ANR for euro area annual inflation). Returns the resolved series title and dimensions plus the requested observations, each with a time period and numeric value. Use start_period and end_period to bound the date range; otherwise the most recent observations are returned. Discover series keys via the datasets/series/search endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• series string required — Full series key identifying a single time series (examples: "EXR.D.USD.EUR.SP00.A", "ICP.M.U2.N.000000.4.ANR", "FM.B.U2.EUR.4F.KR.MRR_FR.LEV")
• count integer required — Number of most recent observations to return (min: 1)
• 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 — Series not found 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.