Catalog

Find Locations

Changed on

Search for geographic locations by name or ID to retrieve standardized location data including city, region, and country. Use the location IDs in the job_location_or and job_location_not filters of a job search to filter by city or region.

get/v0/catalog/locations

Request

  • Base URL
    https://api.theirstack.com
  • URL
    https://api.theirstack.com/v0/catalog/locations
  • Auth
    HTTP bearer

Query parameters

integer
OR
integer[]
namestring nullable

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

Example:Paris
country_codestring nullable

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

Example:FR
string
OR
string[]
offsetinteger

The offset of the results

limitinteger

The limit of the results

Example:10

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"
  }
]

Changes