/expatistan/cities/compare

POST /api/expatistan/cities/compare

Price: 5 credits

Compare the cost of living of two cities: the overall and per-category difference and every item's price side by side with its percentage difference

How to use it

Every difference_percent is the second city relative to the first, negative when prices are lower in the second city. Without currency the first city's prices are in its local currency and each second city price also carries its value converted into that currency; with currency every price is in it.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• first_city string required — Expatistan alias or page URL of the city to compare against (examples: "london", "https://www.expatistan.com/cost-of-living/berlin"; minLength: 1)
• second_city string required — Expatistan alias or page URL of the city compared (examples: "santiago-chile"; minLength: 1)
• currency string nullable — Currency to express both cities' prices in (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: "ExpatistanCityComparison")
• url string required
• headline string nullable
• comparison string nullable
• difference_percent number nullable
• currency string nullable
• price_count integer nullable
• contributor_count integer nullable
• data_quality_note string nullable
• updated_date string nullable
• exchange_rate number nullable
• exchange_rate_pair string nullable
• category_differences array (default: [])
  • @type string (default: "ExpatistanCategoryDifference")
  • category string required
  • difference_percent number nullable
• prices array (default: [])
  • @type string (default: "ExpatistanComparedPrice")
  • category string nullable
  • item_key string nullable
  • name string required
  • first_price number nullable
  • first_price_text string nullable
  • second_price number nullable
  • second_price_text string nullable
  • second_converted_price number nullable
  • second_converted_price_text string nullable
  • difference_percent number nullable
• first_alias string required
• first_name string nullable
• first_country string nullable
• second_alias string required
• second_name string nullable
• second_country string 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 — Expatistan does not know one of the cities or has no prices for it yet 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.