/ourworldindata/charts/search

POST /api/ourworldindata/charts/search

Price: 20 credits

Search Our World in Data charts, explorer views and multi-view chart views by text, countries covered and topic: title, subtitle, result type, countries with data, chart tabs, publish and update dates and URL.

How to use it

Finds charts to feed ourworldindata/charts and ourworldindata/charts/data; an explorerView hit goes to ourworldindata/explorers/data with its URL. Countries are matched by English name, and topic takes a name from ourworldindata/topics/search. One query reaches at most 3000 results.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Search text (examples: "inflation", "life expectancy")
• countries array nullable — Keep charts with data for these countries or regions, by name (examples: ["Germany"])
• require_all_countries boolean — Keep only charts covering every listed country rather than any of them (default: false)
• topic string nullable — Topic or area name (examples: "Life Expectancy", "Health")
• count integer required — Max number of charts to return (min: 1; max: 3000)

Response

• @type string (default: "OurWorldInDataChartHit")
• url string required
• alias string nullable
• subtitle string nullable
• variant_name string nullable
• result_type string nullable
• container_title string nullable
• view_query string nullable
• available_entities array (default: [])
• original_available_entities array (default: [])
• available_tabs array (default: [])
• published_at integer nullable
• updated_at integer nullable

Errors

• 422 — Unknown topic 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 — The entity was not found, or a precondition failed 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.