/ourworldindata/explorers/data

POST /api/ourworldindata/explorers/data

Price: 70 credits

Data points of one Our World in Data explorer view: one value per country or region, year or date, and indicator, with the indicator name and unit, filterable by countries and a year range.

How to use it

Picks the view from the URL's query and the dimensions given; dimensions left out take the explorer's default. Valid combinations come from ourworldindata/explorers/views. Narrow with countries and year_from/year_to.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• explorer string required — Explorer slug or view URL (examples: "population-and-demography", "https://ourworldindata.org/explorers/co2?Gas+or+warming=CO%E2%82%82&Count=Per+capita"; minLength: 1)
• dimensions object nullable — View choice per explorer dimension (examples: {"Age":"Total","Sex":"Female"})
  • * string
• countries array nullable — Keep only these countries or regions, by name or ISO code (examples: ["Germany","USA"])
• year_from integer nullable — Keep only values from this year on (examples: 2000)
• year_to integer nullable — Keep only values up to this year (examples: 2020)
• count integer required — Max number of data points to return (min: 1)

Response

• @type string (default: "OurWorldInDataDataPoint")
• id string (default: "")
• entity_name string required
• entity_code string nullable
• entity_id string nullable
• year integer nullable
• date string nullable
• indicator_id string nullable
• indicator_name string nullable
• unit string nullable
• value number nullable
• value_text string nullable

Errors

• 422 — Unknown view dimension, choice or country 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 — Explorer 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.