Amadeus · Schema

Location

Location schema from Airport & City Search

TravelTravel TechnologyReservationsFlightsHotelsAirlinesHospitalityTours and ActivitiesCars and TransfersDestination ContentItinerary ManagementTrip PlanningArtificial IntelligenceMarket Insights

Properties

Name	Type	Description
id	string	id of the ressource
self	object
type	string	the resource name
subType	string	location sub type
name	string	short name of the location
detailedName	string	detailed name of the location. For a city location it contains city name and country code. For an airport location it contains city name; country code and airport full name
timeZoneOffset	string	timezone offset of the location at the date of the API call (including daylight saving time)
iataCode	string	IATA code of the location. ([IATA table codes](http://www.iata.org/publications/Pages/code-search.aspx) here)
geoCode	object
address	object
distance	object
analytics	object
relevance	number	score value calculated based on distance and analytics
category	string	category of the location
tags	array	list of tags related to the location
rank	string	the rank is the position compared to other locations based on how famous is a place. 1 being the highest.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/airport-city-search-location-schema.json",
  "title": "Location",
  "description": "Location schema from Airport & City Search",
  "properties": {
    "id": {
      "description": "id of the ressource",
      "type": "string",
      "example": "12345"
    },
    "self": {
      "required": [
        "href"
      ],
      "properties": {
        "href": {
          "type": "string",
          "format": "uri",
          "example": "https://example.com/resource"
        },
        "methods": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "GET",
              "PUT",
              "DELETE",
              "POST",
              "PATCH"
            ]
          }
        },
        "count": {
          "type": "integer",
          "example": 1
        }
      },
      "example": {
        "href": "string"
      }
    },
    "type": {
      "description": "the resource name",
      "type": "string",
      "example": "location"
    },
    "subType": {
      "description": "location sub type",
      "type": "string",
      "enum": [
        "AIRPORT",
        "CITY",
        "POINT_OF_INTEREST",
        "DISTRICT"
      ],
      "example": "AIRPORT"
    },
    "name": {
      "description": "short name of the location",
      "type": "string",
      "example": "Paris CDG"
    },
    "detailedName": {
      "description": "detailed name of the location. For a city location it contains city name and country code. For an airport location it contains city name; country code and airport full name",
      "type": "string",
      "example": "Paris/FR: Charles de Gaulle"
    },
    "timeZoneOffset": {
      "description": "timezone offset of the location at the date of the API call (including daylight saving time)",
      "type": "string",
      "example": "+01:00"
    },
    "iataCode": {
      "description": "IATA code of the location. ([IATA table codes](http://www.iata.org/publications/Pages/code-search.aspx) here)",
      "type": "string",
      "example": "CDG"
    },
    "geoCode": {
      "properties": {
        "latitude": {
          "description": "latitude of the location",
          "type": "number",
          "format": "double",
          "example": 43.580418
        },
        "longitude": {
          "description": "longitude of the location",
          "type": "number",
          "format": "double",
          "example": 7.125102
        }
      }
    },
    "address": {
      "properties": {
        "cityName": {
          "description": "name of the city of the location; equal to name if the location is a city",
          "type": "string",
          "example": "Paris"
        },
        "cityCode": {
          "description": "IATA code of the city of the location; equal to IATAcode if the location is a city",
          "type": "string",
          "example": "PAR"
        },
        "countryName": {
          "description": "name of the country of the location",
          "type": "string",
          "example": "France"
        },
        "countryCode": {
          "description": "code of the country of the location in ISO standard",
          "type": "string",
          "example": "FR"
        },
        "stateCode": {
          "description": "code of the state of the location if any",
          "type": "string",
          "example": "TO"
        },
        "regionCode": {
          "description": "code of the region of the location in ISO standard",
          "type": "string",
          "example": "EUROP"
        }
      }
    },
    "distance": {
      "properties": {
        "value": {
          "description": "great-circle distance between two locations. This distance thus do not take into account traffic conditions; international boundaries; mountains; water; or other elements that might make the a nearby location hard to reach.",
          "type": "integer",
          "example": 152
        },
        "unit": {
          "description": "unit of the distance",
          "type": "string",
          "example": "KM",
          "enum": [
            "KM",
            "MI"
          ]
        }
      }
    },
    "analytics": {
      "properties": {
        "travelers": {
          "properties": {
            "score": {
              "type": "number",
              "format": "integer",
              "description": "Approximate score for ranking purposes calculated based on number of travelers in the location.",
              "example": 68
            }
          }
        }
      }
    },
    "relevance": {
      "type": "number",
      "format": "double",
      "description": "score value calculated based on distance and analytics",
      "example": 9.6584
    },
    "category": {
      "description": "category of the location",
      "type": "string",
      "enum": [
        "SIGHTS",
        "BEACH_PARK",
        "HISTORICAL",
        "NIGHTLIFE",
        "RESTAURANT",
        "SHOPPING"
      ],
      "example": "HISTORICAL"
    },
    "tags": {
      "description": "list of tags related to the location",
      "type": "array",
      "items": {
        "type": "string",
        "example": [
          "grocery",
          "japanese",
          "cafe"
        ]
      }
    },
    "rank": {
      "description": "the rank is the position compared to other locations based on how famous is a place. 1 being the highest.",
      "type": "string",
      "example": 1
    }
  },
  "type": "object"
}