/numbeo/cities/property_investment

POST /api/numbeo/cities/property_investment

Price: 5 credits

Get a city's property prices: price to income and price to rent ratios, rental yields, mortgage burden, rent and purchase prices per square meter, and national economic context

How to use it

Pass the alias from a Numbeo city URL or the numeric id from numbeo/cities/search. Prices come in the city's local currency unless currency is set. A city with too few contributors returns its identity and nearby cities with the ratios empty, so do not read empty ratios as zero.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string required — City alias, numeric Numbeo city id or Numbeo city page URL (examples: "Berlin", "London-Canada", "5439", "https://www.numbeo.com/crime/in/New-York"; minLength: 1)
• currency string nullable — Currency to express prices in; the city'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: "NumbeoCityPropertyInvestment")
• id string required
• alias string nullable
• url string nullable
• name string required
• country string nullable
• nearby_cities array (default: [])
  • @type string (default: "NumbeoNearbyCity")
  • name string required
  • alias string nullable
  • url string nullable
  • distance_km number nullable
• price_to_income_ratio number nullable
• mortgage_as_percentage_of_income number nullable
• loan_affordability_index number nullable
• price_to_rent_ratio_city_centre number nullable
• price_to_rent_ratio_outside_centre number nullable
• gross_rental_yield_city_centre number nullable
• gross_rental_yield_outside_centre number nullable
• currency string 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
• gdp_per_capita_usd number nullable
• gdp_growth_rate number nullable
• population_growth_rate number nullable
• world_bank_year integer nullable
• entry_count integer nullable
• contributor_count integer nullable
• updated_date string nullable
• sources array (default: [])
  • @type string (default: "NumbeoSource")
  • name string required
  • url 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 — No Numbeo city matches the alias, id 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.