v10

latestOpenAPI 3.1.02026-08-0452108384.4 KB
Catalog

Get Geographic Locations

Search for geographic locations by name or ID to retrieve standardized location data including city, region, and country. Use location IDs with job_location_or and job_location_not filters for precise geographic targeting in job searches.

get/v0/catalog/locations

Query parameters

integer
OR
integer[]

The ids of the locations

namestring nullable

Search value for the location, this will be used to filter the locations by name

Example:Paris

Search value for the location, this will be used to filter the locations by name

country_codestring nullable

The country code of the location, all the returned locations will be filtered by this country code

Example:FR

The country code of the location, all the returned locations will be filtered by this country code

string
OR
string[]

GeoNames feature code(s) to filter by location type (e.g. PPL=populated place, ADM1=first-order admin division). See https://www.geonames.org/export/codes.html

offsetinteger

The offset of the results

The offset of the results

limitinteger

The limit of the results

Example:10

The limit of the results

Response

Successful Response

idinteger required

The unique identifier for the location, is based on the geonameid field from the geonames database

namestring required

The name of the location

admin1_namestring nullable

The name of the first-level administrative division (e.g., state or province) of the location

country_codestring nullable

The ISO 3166-1 alpha-2 code of the country of the location

feature_codestring required

The feature code of the location

feature_name'city' | 'region' | 'country' | 'continent' required
display_namestring required
country_namestring nullable required

Example response

[
  {
    "id": 5128581,
    "name": "New York",
    "admin1_name": "New York",
    "country_code": "US",
    "feature_code": "PPL"
  }
]