/worldbank/countries

POST /api/worldbank/countries

Price: 5 credits

List countries and aggregates with their region, income level and lending type

How to use it

List World Bank countries and regional aggregates. Filter by region, income level or lending type, or by a keyword matched against the country name. Each result gives the ISO3 and ISO2 codes, name, region, admin region, income level, lending type, capital city and coordinates.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Filter countries whose name contains this text (examples: "united", "brazil", "land")
• region string nullable — Restrict to countries in this region (one of: "AFE", "AFR", "AFW", "ARB", "CAA", "CEA", "CEB", "CEU", "CLA", "CME", "CSA", "CSS", "EAP", "EAR", "EAS", "ECA", "ECS", "EMU", "EUU", "FCS", "HPC", "LAC", "LCN", "LDC", "LTE", "MDE", "MEA", "MNA", "NAC", "NAF", "NRS", "OED", "OSS", "PRE", "PSS", "PST", "RRS", "SAS", "SSA", "SSF", "SST", "SXZ", "WLD", "XZN")
• income_level string nullable — Restrict to countries at this income level (one of: "HIC", "INX", "LIC", "LMC", "LMY", "MIC", "UMC")
• lending_type string nullable — Restrict to countries with this World Bank lending type (one of: "IBD", "IDB", "IDX", "LNX")
• count integer required — Max number of countries to return (min: 1)

Response

• @type string (default: "WorldbankCountry")
• id string required
• iso2_code string nullable
• name string nullable
• region object nullable
  • @type string (default: "WorldbankRef")
  • id string nullable
  • iso2_code string nullable
  • value string nullable
• adminregion object nullable
  • @type string (default: "WorldbankRef")
  • id string nullable
  • iso2_code string nullable
  • value string nullable
• income_level object nullable
  • @type string (default: "WorldbankRef")
  • id string nullable
  • iso2_code string nullable
  • value string nullable
• lending_type object nullable
  • @type string (default: "WorldbankRef")
  • id string nullable
  • iso2_code string nullable
  • value string nullable
• capital_city string nullable
• longitude number nullable
• latitude number 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 — 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.