/nomads/cities/search

POST /api/nomads/cities/search

Price: 20 credits

Search Nomads.com's ranked list of cities for remote workers, optionally within one country or continent, sorted by any of Nomads' city attributes

How to use it

Pass the country by its English name as Nomads shows it, such as United States. Sorting by an attribute leaves out cities that have no value for it. rank is Nomads' overall rank and stays the same under every sort.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string nullable — Country name to restrict the cities to (examples: "Thailand", "United States")
• continent string nullable — Continent to restrict the cities to (one of: "asia", "europe", "north-america", "latin-america", "africa", "middle-east", "oceania", "antarctica"; examples: "asia")
• sort string — Attribute the cities are ranked by (default: "nomad_score"; one of: "nomad_score", "solomad_score", "family_score", "life_score", "cost_for_nomad_in_usd", "internet_speed", "leisure_quality", "safety_level", "temperatureC", "temperatureC_feels_like", "temperatureC_annual_median", "air_quality_now", "air_quality_annual_or_now", "ac_prevalence", "humidity", "likes_ratio", "users_count_est", "users_count_been_est", "users_count_male_est", "users_count_female_est", "nomads_percentage_of_population", "nomads_percentage_of_tourists", "trip_length_median", "pageviews_30d", "pageviews_growth_30d", "users_count_been_gender_ratio_female", "nomad_vs_local_gender_ratio", "likes", "dislikes", "likes_percentage", "likes_locals", "dislikes_locals", "likes_male_ratio", "likes_female_ratio", "local_cost_in_usd", "long_term_cost_in_usd", "last_5_year_growth", "last_2_year_growth", "last_1_year_growth", "tourist_visitors_2020_growth", "tourist_visitors_2017", "tourists_per_capita", "return_rate", "altitude", "climate_koppen_name", "hotel_price_in_usd", "airbnb_median_price_in_usd", "apartment_cost_in_usd", "airbnb_vs_apartment_ratio", "median_home_price_in_usd", "beer_in_cafe_in_usd", "environmental_score", "co2_emissions_in_kt", "co2_emissions_per_capita", "noise_decibel", "light_pollution", "uv_index", "commute_time_index", "nightlife", "adult_nightlife", "female_friendly", "friendliness_to_foreigners", "racial_tolerance", "press_freedom_score", "electrical_outages_per_year", "democracy_score", "human_development_index", "education_index_score", "religious", "population", "population_density", "happiness_score", "iq_level", "lgbt_friendly", "refugees_per_1000", "refugees_by_country_of_origin", "legal_drinking_age", "sexual_partners", "sexual_openness", "gdp_per_capita_in_usd", "gdp_growth_rate", "income_inequality", "labor_productivity", "gender_equality", "gender_pay_gap", "venture_capital_per_year_in_usd", "venture_capital_per_year_per_capita", "tax_to_gdp_ratio", "short_term_cost_of_living_vs_gdp_per_capita_ratio", "tax_per_capita_in_usd", "product_quality_index", "birth_rate", "homelessness_per_100k", "gender_ratio_male", "gender_ratio_female", "gender_ratio_young_female", "gender_ratio_young_male", "average_height", "average_height_male", "average_height_female", "overweight_rate", "obesity_rate", "bmi_male", "bmi_female", "plastic_surgery_per_year_per_100k", "diabetes_prevalence", "smoking_prevalence", "smoking_packs_per_year", "alcohol_consumption_per_capita", "calories_per_capita", "carb_to_protein_ratio", "carbs_percentage_per_capita", "protein_percentage_per_capita", "fats_percentage_per_capita", "sugar_consumption_per_capita", "fat_consumption_per_capita", "protein_consumption_per_capita", "coronary_heart_disease_death_rate", "cancer_rate", "life_expectancy", "median_age", "healthcare_score", "hospital_score", "suicide_rate", "crossfit_gyms", "corona_cases", "corona_cases_per_million", "corona_deaths", "corona_deaths_per_million", "corona_tests", "corona_tests_per_million", "corona_cases_per_tests_percentage", "corona_death_rate", "guns_per_capita", "homicide_rate", "natural_disaster_risk", "road_traffic_score", "hofstede_hierarchical", "hofstede_masculinity", "hofstede_uncertainty_avoidance", "hofstede_individualism", "ex_colony", "ex_colony_non_native_independent", "ex_colony_returned_to_natives", "hoodmaps_hipsters", "hoodmaps_suits", "hoodmaps_normies", "hoodmaps_tourists", "hoodmaps_uni", "hoodmaps_rich", "climate_temperatureC_month_01", "climate_temperatureC_month_02", "climate_temperatureC_month_03", "climate_temperatureC_month_04", "climate_temperatureC_month_05", "climate_temperatureC_month_06", "climate_temperatureC_month_07", "climate_temperatureC_month_08", "climate_temperatureC_month_09", "climate_temperatureC_month_10", "climate_temperatureC_month_11", "climate_temperatureC_month_12", "climate_uv_index_month_01", "climate_uv_index_month_02", "climate_uv_index_month_03", "climate_uv_index_month_04", "climate_uv_index_month_05", "climate_uv_index_month_06", "climate_uv_index_month_07", "climate_uv_index_month_08", "climate_uv_index_month_09", "climate_uv_index_month_10", "climate_uv_index_month_11", "climate_uv_index_month_12", "climate_humidity_month_01", "climate_humidity_month_02", "climate_humidity_month_03", "climate_humidity_month_04", "climate_humidity_month_05", "climate_humidity_month_06", "climate_humidity_month_07", "climate_humidity_month_08", "climate_humidity_month_09", "climate_humidity_month_10", "climate_humidity_month_11", "climate_humidity_month_12", "users_count_month_01_est", "users_count_month_02_est", "users_count_month_03_est", "users_count_month_04_est", "users_count_month_05_est", "users_count_month_06_est", "users_count_month_07_est", "users_count_month_08_est", "users_count_month_09_est", "users_count_month_10_est", "users_count_month_11_est", "users_count_month_12_est", "nomad_score_month_01", "nomad_score_month_02", "nomad_score_month_03", "nomad_score_month_04", "nomad_score_month_05", "nomad_score_month_06", "nomad_score_month_07", "nomad_score_month_08", "nomad_score_month_09", "nomad_score_month_10", "nomad_score_month_11", "nomad_score_month_12", "latitude", "longitude"; examples: "nomad_score", "cost_for_nomad_in_usd")
• order string nullable — Sort direction; the direction Nomads uses for this attribute when omitted (one of: "asc", "desc"; examples: "asc")
• count integer required — Max number of cities to return (min: 1)

Response

• @type string (default: "NomadsCitySummary")
• alias string required
• long_alias string nullable
• url string nullable
• name string required
• country string nullable
• country_code string nullable
• country_alias string nullable
• region string nullable
• state string nullable
• state_code string nullable
• latitude number nullable
• longitude number nullable
• population integer nullable
• rank integer nullable
• nomad_score number nullable
• cost_score number nullable
• internet_score number nullable
• likes_score number nullable
• safety_score number nullable
• air_quality_score number nullable
• air_quality_now_score number nullable
• internet_speed_mbps number nullable
• air_quality number nullable
• air_quality_now number nullable
• humidity_percent number nullable
• ac_prevalence_percent number nullable
• temperature_c number nullable
• temperature_f number nullable
• feels_like_c number nullable
• feels_like_f number nullable
• weather_icon string nullable
• weather_emoji string nullable
• cost_for_nomad_usd number nullable
• cost_for_expat_usd number nullable
• cost_for_local_usd number nullable
• cost_for_family_usd number nullable
• members_here_count integer nullable
• members_here_estimated_count integer nullable
• members_been_count integer nullable
• members_been_estimated_count integer nullable
• trips_growth_2y_percent number nullable
• image string nullable
• image_updated_at integer nullable
• video_thumbnail string nullable
• name_chinese string nullable
• country_chinese string nullable
• state_chinese 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 has no city in that country, or none of its cities lies in the continent given 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.