/nomads/cities/related

POST /api/nomads/cities/related

Price: 20 credits

Get the cities Nomads relates to a city: nearby cities with travel time, where members go next, and similar cities, each with cost, internet, weather and rating bars

How to use it

relation is near, next or similar, and position is the order Nomads shows within that relation. Pass a row's long_alias to nomads/cities for its full record.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string required — Nomads city alias or city page URL (examples: "bangkok", "bangkok-thailand", "https://nomads.com/chiang-mai"; minLength: 1)
• relation string nullable — Keep only one kind of related city; every kind when omitted (one of: "near", "next", "similar"; examples: "near")
• count integer required — Max number of related cities to return (min: 1)

Response

• @type string (default: "NomadsRelatedCity")
• relation string required
• position integer required
• long_alias string required
• url string nullable
• name string nullable
• country string nullable
• country_alias string nullable
• image string nullable
• overall_level_percent number nullable
• cost_rating integer nullable
• cost_label string nullable
• internet_rating integer nullable
• internet_label string nullable
• liked_rating integer nullable
• liked_label string nullable
• safety_rating integer nullable
• safety_label string nullable
• cost_for_nomad_usd number nullable
• cost_for_expat_usd number nullable
• internet_speed_mbps number nullable
• temperature_c number nullable
• feels_like_c number nullable
• weather_emoji string nullable
• ac_prevalence_percent number nullable
• ac_label string nullable
• air_quality number nullable
• travel_time string nullable
• travel_mode 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 — Nomads does not know the city 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.