/numbeo/countries/cost_of_living

POST /api/numbeo/countries/cost_of_living

Price: 10 credits

Get a country's cost of living: average prices across its cities, estimated monthly costs and the cost of living indices of each of its cities

How to use it

Pass the English country name as Numbeo spells it, such as United Kingdom or United States. Prices come in the country's local currency unless currency is set.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string required — Country name in English or Numbeo country page URL (examples: "Germany", "United Kingdom", "https://www.numbeo.com/crime/country_result.jsp?country=Germany"; minLength: 1)
• currency string nullable — Currency to express prices in; the country's local currency when omitted (one of: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTC", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNH", "CNY", "COP", "CRC", "CUC", "CVE", "CZK", "DJF", "DKK", "DOP", "EGP", "ERN", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MNT", "MOP", "MRU", "MUR", "MVR", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "YER", "ZAR", "ZMW", "ZWG", "ZWL"; examples: "USD")

Response

• @type string (default: "NumbeoCountryCostOfLiving")
• name string required
• url string nullable
• currency string nullable
• monthly_cost_family number nullable
• monthly_cost_single number nullable
• prices array (default: [])
  • @type string (default: "NumbeoPrice")
  • category string nullable
  • name string required
  • value number nullable
  • range_min number nullable
  • range_max number nullable
• entry_count integer nullable
• contributor_count integer nullable
• is_estimated boolean (default: false)
• updated_date string nullable
• sources array (default: [])
  • @type string (default: "NumbeoSource")
  • name string required
  • url string nullable
• cities array (default: [])
  • @type string (default: "NumbeoCostOfLivingRanking")
  • rank integer nullable
  • name string required
  • country string nullable
  • alias string nullable
  • url string nullable
  • cost_of_living_index number nullable
  • rent_index number nullable
  • cost_of_living_plus_rent_index number nullable
  • groceries_index number nullable
  • restaurant_price_index number nullable
  • local_purchasing_power_index 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 — No Numbeo country matches the name or URL 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.