common/locations

Generic endpoints related with geographical locations: countries, cities, etc.

List airports

This endpoint returns a list of airport codes and their names in the selected languages. The airports returned may be filtered by a location id. For example, you can get the list of airports in The Netherlands by passing: {"country":"nl"}. To get the full list call the endpoint passing an empty body. The airport codes returned are what is used as input and output for other endpoints. This endpoint implements pagination of the results.

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
airport
string^[A-Z]{3}$

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling common/locations/airports.

city
integer

A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.

country
string^[a-z]{2}$

A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.

district
integer >= 1

A signed integer number that uniquely identifies a district. Typically, districts define known areas within a city. The full list can be obtained by calling common/locations/districts.

landmark
integer >= 1

A signed integer number that uniquely identifies a relevant geographical landmark, like a monument or a natural attraction. The full list can be obtained by calling common/locations/landmarks.

languages
Array of strings
Default: ["en-gb"]
page
string

Pagination token used to retrieve the next page of results. Obtained from next_page.

region
integer >= 1

A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.

rows
integer multiple of 10 [ 10 .. 1000 ]
Default: 100

The maximum number of results to return.

post
/common/locations/airports
Request samples
application/json
{ "country": "nl", "languages": [ "en-gb", "zh-cn" ] }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

Array of objects
next_page
string or null

Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter page).

Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ "..." ], "next_page": null }

List cities

This endpoint returns a list of city codes and their names in the selected languages. The cities returned may be filtered by a location id. For example, you can get the list of cities in The Netherlands by passing: {"country":"nl"}. To get the full list call the endpoint passing an empty body. The city codes returned are what is used as input and output for other endpoints. This endpoint implements pagination of the results.

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
airport
string^[A-Z]{3}$

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling common/locations/airports.

city
integer

A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.

country
string^[a-z]{2}$

A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.

district
integer >= 1

A signed integer number that uniquely identifies a district. Typically, districts define known areas within a city. The full list can be obtained by calling common/locations/districts.

landmark
integer >= 1

A signed integer number that uniquely identifies a relevant geographical landmark, like a monument or a natural attraction. The full list can be obtained by calling common/locations/landmarks.

languages
Array of strings
Default: ["en-gb"]
page
string

Pagination token used to retrieve the next page of results. Obtained from next_page.

region
integer >= 1

A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.

rows
integer multiple of 10 [ 10 .. 1000 ]
Default: 100

The maximum number of results to return.

post
/common/locations/cities
Request samples
application/json
{ "country": "nl", "languages": [ "en-gb", "zh-cn" ] }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

Array of objects
next_page
string or null

Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter page).

Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ "..." ], "next_page": "..." }

List countries

This endpoint returns a list of country codes and their names in the selected languages. The countries returned may be filtered by a location id. For example, you can get the list of countries that are associated with the European Alps region by passing: {"region":1199}. To get the full list call the endpoint passing an empty body. The country codes returned are what is used as input and output for other endpoints. This endpoint implements pagination of the results.

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
airport
string^[A-Z]{3}$

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling common/locations/airports.

city
integer

A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.

country
string^[a-z]{2}$

A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.

district
integer >= 1

A signed integer number that uniquely identifies a district. Typically, districts define known areas within a city. The full list can be obtained by calling common/locations/districts.

landmark
integer >= 1

A signed integer number that uniquely identifies a relevant geographical landmark, like a monument or a natural attraction. The full list can be obtained by calling common/locations/landmarks.

languages
Array of strings
Default: ["en-gb"]
page
string

Pagination token used to retrieve the next page of results. Obtained from next_page.

region
integer >= 1

A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.

rows
integer multiple of 10 [ 10 .. 1000 ]
Default: 100

The maximum number of results to return.

post
/common/locations/countries
Request samples
application/json
{ "languages": [ "en-gb", "zh-cn" ] }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

Array of objects
next_page
string or null

Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter page).

Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ "..." ], "next_page": "..." }

List districts

This endpoint returns a list of districts with translations in the selected languages. The districts returned may be filtered by a location id. For example, you can get the list of districts in Amsterdam by passing: {"city":-2140479}. To get the full list call the endpoint passing an empty body. The district ids returned are what is used as input and output for other endpoints. This endpoint implements pagination of the results.

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
airport
string^[A-Z]{3}$

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling common/locations/airports.

city
integer

A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.

country
string^[a-z]{2}$

A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.

district
integer >= 1

A signed integer number that uniquely identifies a district. Typically, districts define known areas within a city. The full list can be obtained by calling common/locations/districts.

landmark
integer >= 1

A signed integer number that uniquely identifies a relevant geographical landmark, like a monument or a natural attraction. The full list can be obtained by calling common/locations/landmarks.

languages
Array of strings
Default: ["en-gb"]
page
string

Pagination token used to retrieve the next page of results. Obtained from next_page.

region
integer >= 1

A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.

rows
integer multiple of 10 [ 10 .. 1000 ]
Default: 100

The maximum number of results to return.

post
/common/locations/districts
Request samples
application/json
{ "city": -2140479, "languages": [ "en-gb", "zh-cn" ] }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

Array of objects
next_page
string or null

Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter page).

Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ "..." ], "next_page": null }

List landmarks

This endpoint returns a list of relevant geographical landmark codes and their names in the selected languages. The landmarks returned may be filtered by a location id. For example, you can get the list of landmarks that are associated with the city of Paris in France by passing: {"city":-1456928}. To get the full list call the endpoint passing an empty body. The landmark codes returned are what is used as input and output for other endpoints. This endpoint implements pagination of the results.

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
airport
string^[A-Z]{3}$

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling common/locations/airports.

city
integer

A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.

country
string^[a-z]{2}$

A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.

district
integer >= 1

A signed integer number that uniquely identifies a district. Typically, districts define known areas within a city. The full list can be obtained by calling common/locations/districts.

landmark
integer >= 1

A signed integer number that uniquely identifies a relevant geographical landmark, like a monument or a natural attraction. The full list can be obtained by calling common/locations/landmarks.

languages
Array of strings
Default: ["en-gb"]
page
string

Pagination token used to retrieve the next page of results. Obtained from next_page.

region
integer >= 1

A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.

rows
integer multiple of 10 [ 10 .. 1000 ]
Default: 100

The maximum number of results to return.

post
/common/locations/landmarks
Request samples
application/json
{ "city": -2140479, "languages": [ "en-gb", "zh-cn" ] }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

Array of objects
next_page
string or null

Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter page).

Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ "..." ], "next_page": "..." }

List regions

This endpoint returns a list of regions with translations in the selected languages. The regions returned may be filtered by a location id. For example, you can get the list of regions in the Netherlands or that the Netherlands is a part of by passing: {"country":"nl"}. To get the full list call the endpoint passing an empty body. The region ids returned are what is used as input and output for other endpoints. This endpoint implements pagination of the results.

SecurityHTTP: BearerAuth
Request
header Parameters
X-Affiliate-Id
required
integer

Affiliate identifier

Request Body schema: application/json
airport
string^[A-Z]{3}$

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling common/locations/airports.

city
integer

A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.

country
string^[a-z]{2}$

A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.

landmark
integer >= 1

A signed integer number that uniquely identifies a relevant geographical landmark, like a monument or a natural attraction. The full list can be obtained by calling common/locations/landmarks.

languages
Array of strings
Default: ["en-gb"]
page
string

Pagination token used to retrieve the next page of results. Obtained from next_page.

region
integer >= 1

A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.

rows
integer multiple of 10 [ 10 .. 1000 ]
Default: 100

The maximum number of results to return.

post
/common/locations/regions
Request samples
application/json
{ "country": "nl", "languages": [ "en-gb", "zh-cn" ] }
Responses

200

Successful response.

Response Schema: application/json
request_id
string

Uniquely identifies the request. Please provide this identifier when contacting support.

Array of objects
next_page
string or null

Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter page).

Response samples
application/json
{ "request_id": "01fr9ez700exycb98w90w5r9sh", "data": [ "..." ], "next_page": null }