location
Returns a list of airports and cities matching a given keyword.
get/reference-data/locations
Request
- Base URLhttps://test.api.amadeus.com/v1
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
subTypestring[] required
sub type of the location (AIRPORT and/or CITY)
keywordstring required
keyword that should represent the start of a word in a city or airport name or code. Supported charaters are: A-Za-z0-9./:-'()"
countryCodestring
Country code of the location using ISO 3166-1 alpha-2 code format (e.g. US).
page[limit]integer
maximum items in one page
page[offset]integer
start index of the requested page
sort'analytics.travelers.score'
defines on which attribute the sorting will be done:
- analytics.travelers.score - sort by the number of travelers by airport or city, the airports and cities with the highest traffic are on top of the results
view'LIGHT' | 'FULL'
select the level of information of the reply:
- LIGHT - Gives only the IATACode, name, detailedName, cityName and countryName
- FULL - Adds on top of the LIGHT information the timeZoneOffset, geocode, detailed address and travelers.score default option is FULL
Response
Successful Operation
Example response
{
"meta": {
"count": 2,
"links": {
"self": "https://test.api.amadeus.com/v1/reference-data/locations?subType=CITY,AIRPORT&keyword=MUC&countryCode=DE"
}
},
"data": [
{
"type": "location",
"subType": "CITY",
"name": "MUNICH INTERNATIONAL",
"detailedName": "MUNICH/DE:MUNICH INTERNATIONAL",
"id": "CMUC",
"self": {
"href": "https://test.api.amadeus.com/v1/reference-data/locations/CMUC",
"methods": [
"GET"
]
},
"timeZoneOffset": "+02:00",
"iataCode": "MUC",
"geoCode": {
"latitude": 48.35378,
"longitude": 11.78609
},
"address": {
"cityName": "MUNICH",
"cityCode": "MUC",
"countryName": "GERMANY",
"countryCode": "DE",
"regionCode": "EUROP"
},
"analytics": {
"travelers": {
"score": 27
}
}
},
{
"type": "location",
"subType": "AIRPORT",
"name": "MUNICH INTERNATIONAL",
"detailedName": "MUNICH/DE:MUNICH INTERNATIONAL",
"id": "AMUC",
"self": {
"href": "https://test.api.amadeus.com/v1/reference-data/locations/AMUC",
"methods": [
"GET"
]
},
"timeZoneOffset": "+02:00",
"iataCode": "MUC",
"geoCode": {
"latitude": 48.35378,
"longitude": 11.78609
},
"address": {
"cityName": "MUNICH",
"cityCode": "MUC",
"countryName": "GERMANY",
"countryCode": "DE",
"regionCode": "EUROP"
},
"analytics": {
"travelers": {
"score": 27
}
}
}
]
}Changes
No recorded changes to this operation across all 4 revisions of this API.