/expatistan/countries

POST /api/expatistan/countries

Price: 10 credits

Get the cost of living in a country: itemised prices by category, estimated monthly costs, the country's regional and world ranking, its cities ranked by price index and every city Expatistan lists there

How to use it

Pass the country alias as it appears in Expatistan URLs, such as united-states. A currency adds the converted value to each price and monthly cost, plus the exchange_rate used and its exchange_rate_pair. Cities with has_prices false have no prices yet and are rejected by expatistan/cities; some cities with has_prices true have no prices yet either and are rejected the same way.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string required — Expatistan country alias or country page URL (examples: "chile", "united-states", "https://www.expatistan.com/cost-of-living/country/germany"; minLength: 1)
• currency string nullable — Currency to convert every price into, beside the local price (one of: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "AOAX", "ARS", "ARSX", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "IRRX", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KPWX", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LBPX", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "LYDX", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NGNX", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SDGX", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "SSPX", "STD", "SYP", "SYPX", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "UZSX", "VEF", "VEFX", "VES", "VESX", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW"; examples: "USD")

Response

• @type string (default: "ExpatistanCountry")
• alias string required
• name string required
• url string required
• currency string nullable
• display_currency string nullable
• exchange_rate number nullable
• exchange_rate_pair string nullable
• family_monthly_cost number nullable
• family_monthly_cost_text string nullable
• family_monthly_cost_converted number nullable
• family_monthly_cost_converted_text string nullable
• single_monthly_cost number nullable
• single_monthly_cost_text string nullable
• single_monthly_cost_converted number nullable
• single_monthly_cost_converted_text string nullable
• rankings array (default: [])
  • @type string (default: "ExpatistanRankPosition")
  • region string required
  • rank integer nullable
  • total_count integer nullable
  • comparison string nullable
  • percent_of_places number nullable
• prices array (default: [])
  • @type string (default: "ExpatistanPrice")
  • category string nullable
  • item_key string nullable
  • name string required
  • price number nullable
  • price_text string nullable
  • converted_price number nullable
  • converted_price_text string nullable
• city_ranking array (default: [])
  • @type string (default: "ExpatistanCountryRankedCity")
  • rank integer nullable
  • alias string required
  • name string required
  • url string nullable
  • price_index number nullable
• cities array (default: [])
  • @type string (default: "ExpatistanCountryCity")
  • alias string required
  • name string required
  • url string nullable
  • has_prices boolean required

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 — Expatistan does not know the country 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.