/bis/datasets

POST /api/bis/datasets

Price: 1 credit

Get observations from a BIS dataset by its id, sliced by dimension filters

How to use it

Fetch numeric observations from a single BIS (Bank for International Settlements) statistical dataset by its id (e.g. WS_CBPOL for central bank policy rates, WS_TC for total credit to the non-financial sector, WS_EER for effective exchange rates). Each observation is returned as a flat record with the code for every series dimension (frequency, reference area, etc.), the time period, and the numeric value. Use the filters, since, and until arguments to slice the dataset to the cells you need — an unfiltered dataset can contain millions of cells. Look up the available dimension ids and value codes for a dataset via the dimensions endpoint.

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 id (examples: "WS_CBPOL", "WS_TC", "WS_EER")
• count integer required — Number of observations to return (min: 1)
• agency string — Maintenance agency id (default: "BIS"; examples: "BIS")
• version string — Dataset version (default: "1.0"; examples: "1.0")
• filters object nullable — Dimension filters as a mapping of dimension id to allowed value codes (examples: {"FREQ":["M"],"REF_AREA":["US"]})
  • * array
• since string nullable — Earliest time period, inclusive (examples: "2020", "2024-01")
• until string nullable — Latest time period, inclusive (examples: "2024", "2024-06")
• last_n_observations integer nullable — Return only the latest N observations of each series (examples: 10; min: 1)
• first_n_observations integer nullable — Return only the earliest N observations of each series (examples: 10; min: 1)

Response

• @type string (default: "BisObservation")
• dimensions array required
  • @type string (default: "BisObservationDimension")
  • id string required
  • code string required
• time string required
• value union required
• status string nullable
• confidentiality string nullable
• source_ref string nullable
• compilation string nullable
• unit_measure string nullable
• unit_mult 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 observations 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.