/ourworldindata/charts

POST /api/ourworldindata/charts

Price: 10 credits

Our World in Data chart by slug or URL: title, subtitle, notes, chart types, default countries, the view dimensions of a multi-view chart, and every indicator it plots with unit, descriptions, time coverage, update dates and sources with citations and licences.

How to use it

Describes one chart and its indicators; the values themselves come from ourworldindata/charts/data. A multi-view chart such as energy-mix returns its dimensions and the view picked by the URL or by dimensions. Find slugs with ourworldindata/charts/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• chart string required — Chart slug or URL (examples: "life-expectancy", "https://ourworldindata.org/grapher/gdp-per-capita-worldbank", "https://ourworldindata.org/grapher/energy-mix?metric=per_capita&source=total"; minLength: 1)
• dimensions object nullable — View choice per dimension of a multi-view chart (examples: {"metric":"per_capita","source":"total"})
  • * string

Response

• @type string (default: "OurWorldInDataChart")
• url string required
• alias string required
• id string nullable
• config_id string nullable
• chart_kind string nullable
• subtitle string nullable
• note string nullable
• variant_name string nullable
• chart_types array (default: [])
• default_tab string nullable
• has_map_tab boolean nullable
• default_entities array (default: [])
• article_url string nullable
• topic_tags array (default: [])
• dimensions array (default: [])
  • @type string (default: "OurWorldInDataDimension")
  • alias string required
  • name string nullable
  • widget string nullable
  • choices array (default: [])
    • @type string (default: "OurWorldInDataChoice")
    • alias string required
    • name string nullable
    • description string nullable
    • group string nullable
• choices array (default: [])
  • @type string (default: "OurWorldInDataSelectedChoice")
  • dimension string required
  • choice string required
• indicators array (default: [])
  • @type string (default: "OurWorldInDataIndicator")
  • id string required
  • chart_roles array (default: [])
  • name string nullable
  • title_variant string nullable
  • display_name string nullable
  • unit string nullable
  • short_unit string nullable
  • value_type string nullable
  • categories array (default: [])
  • description_short string nullable
  • description_key array (default: [])
  • description_processing string nullable
  • description_from_producer string nullable
  • description string nullable
  • timespan string nullable
  • time_interval string nullable
  • zero_day string nullable
  • entity_count integer nullable
  • time_count integer nullable
  • dataset_id string nullable
  • dataset_name string nullable
  • dataset_version string nullable
  • catalog_path string nullable
  • short_name string nullable
  • processing_level string nullable
  • update_period_days integer nullable
  • is_redistributable boolean nullable
  • attribution string nullable
  • attribution_short string nullable
  • topic_tags array (default: [])
  • created_at integer nullable
  • updated_at integer nullable
  • sources array (default: [])
    • @type string (default: "OurWorldInDataSource")
    • id string nullable
    • title_snapshot string nullable
    • producer string nullable
    • description string nullable
    • description_snapshot string nullable
    • citation string nullable
    • attribution string nullable
    • attribution_short string nullable
    • version string nullable
    • url string nullable
    • download_url string nullable
    • published_date string nullable
    • accessed_date string nullable
    • license_name string nullable
    • license_url string nullable

Errors

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