Flight Most Booked Destinations
Before using this API, we recommend you read our Authorization Guide(https://developers
COMMUNITYNO AUTH0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "test.api.amadeus.com",
"basePath": "/v1",
"info": {
"description": "\nBefore using this API, we recommend you read our **[Authorization Guide](https://developers.amadeus.com/self-service/apis-docs/guides/authorization-262)** for more information on how to generate an access token.\n\nPlease also be aware that our test environment is based on a subset of the production, this API in test only returns a few selected cities. You can find the list in our **[data collection](https://github.com/amadeus4dev/data-collection)**.",
"title": "Flight Most Booked Destinations",
"version": "1.1.1",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_amadeus.com_images_en_technology_mobile-tablet_mobile-woman-office-city.jpg.transform_medium_img.jpg"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/amadeus4dev/amadeus-open-api-specification/main/spec/json/FlightMostBookedDestinations_v1_swagger_specification.json",
"version": "2.0"
}
],
"x-providerName": "amadeus.com",
"x-release-note": {
"1.0": [
"Initial Version"
],
"1.1.0": [
"AFD-1091 - change from \"traveller\" to \"traveler\"",
"Correct example",
"Naming of parameter origin changed for originCityCode"
]
},
"x-serviceName": "amadeus-flight-most-booked-destinations",
"x-status": "validated",
"x-tags": [
"#ama-for-dev"
]
},
"consumes": [
"application/vnd.amadeus+json"
],
"produces": [
"application/vnd.amadeus+json"
],
"parameters": {
"fields": {
"description": "list of attributes desired in the response or list of attributes to remove from the response (with \"-\" before fields) \n* The attributes names must contain the whole path (except resource name) e.g. travelers",
"in": "query",
"name": "fields",
"required": false,
"type": "string"
},
"pageLimit": {
"default": 10,
"description": "maximum items in one page",
"in": "query",
"name": "page[limit]",
"required": false,
"type": "integer"
},
"pageOffset": {
"default": 0,
"description": "start index of the requested page",
"in": "query",
"name": "page[offset]",
"required": false,
"type": "integer"
},
"sort": {
"default": "analytics.travelers.score",
"description": "defines on which attribute the sorting will be done:\n* analytics.flights.score - sort destinations by flights score (decreasing)\n* analytics.travelers.score - sort destination by traveler's score (decreasing)\n",
"enum": [
"analytics.flights.score",
"analytics.travelers.score"
],
"in": "query",
"name": "sort",
"required": false,
"type": "string"
}
},
"responses": {
"400": {
"description": "code | title \n------- | ------------------------------------- \n477 | INVALID FORMAT\n572 | INVALID OPTION\n2781 | INVALID LENGTH\n4926 | INVALID DATA RECEIVED \n32171 | MANDATORY DATA MISSING \t \n",
"schema": {
"$ref": "#/definitions/Error_400"
}
},
"500": {
"description": "Unexpected Error",
"schema": {
"$ref": "#/definitions/Error_500"
}
},
"air-traffic": {
"description": "Successful Operation",
"schema": {
"example": {
"data": [
{
"analytics": {
"flights": {
"score": 100
},
"travelers": {
"score": 100
}
},
"destination": "PAR",
"subType": "BOOKED",
"type": "air-traffic"
},
{
"analytics": {
"flights": {
"score": 61
},
"travelers": {
"score": 80
}
},
"destination": "TCI",
"subType": "BOOKED",
"type": "air-traffic"
},
{
"analytics": {
"flights": {
"score": 93
},
"travelers": {
"score": 65
}
},
"destination": "LON",
"subType": "BOOKED",
"type": "air-traffic"
},
{
"analytics": {
"flights": {
"score": 91
},
"travelers": {
"score": 61
}
},
"destination": "BCN",
"subType": "BOOKED",
"type": "air-traffic"
},
{
"analytics": {
"flights": {
"score": 61
},
"travelers": {
"score": 51
}
},
"destination": "NYC",
"subType": "BOOKED",
"type": "air-traffic"
},
{
"analytics": {
"flights": {
"score": 41
},
"travelers": {
"score": 39
}
},
"destination": "BRU",
"subType": "BOOKED",
"type": "air-traffic"
},
{
"analytics": {
"flights": {
"score": 48
},
"travelers": {
"score": 37
}
},
"destination": "UIO",
"subType": "BOOKED",
"type": "air-traffic"
},
{
"analytics": {
"flights": {
"score": 15
},
"travelers": {
"score": 19
}
},
"destination": "SDQ",
"subType": "BOOKED",
"type": "air-traffic"
},
{
"analytics": {
"flights": {
"score": 22
},
"travelers": {
"score": 11
}
},
"destination": "DXB",
"subType": "BOOKED",
"type": "air-traffic"
},
{
"analytics": {
"flights": {
"score": 18
},
"travelers": {
"score": 8
}
},
"destination": "OPO",
"subType": "BOOKED",
"type": "air-traffic"
}
],
"meta": {
"count": 10,
"links": {
"self": "https://test.api.amadeus.com/v1/travel/analytics/air-traffic/booked?originCityCode=MAD&page%5Blimit%5D=10&page%5Boffset%5D=0&period=2017-08"
}
}
},
"properties": {
"data": {
"items": {
"$ref": "#/definitions/Air_Traffic"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/Collection_Meta"
},
"warnings": {
"items": {
"$ref": "#/definitions/Issue"
},
"type": "array"
}
},
"required": [
"data"
],
"title": "Success"
}
}
},
"paths": {
"/travel/analytics/air-traffic/booked": {
"get": {
"description": "",
"operationId": "getAirTraffic",
"parameters": [
{
"description": "Code for the origin city following IATA standard ([IATA table codes](http://www.iata.org/publications/Pages/code-search.aspx)). - e.g. BOS for Boston",
"in": "query",
"name": "originCityCode",
"pattern": "[A-Za-z]{3}",
"required": true,
"type": "string",
"x-example": "MAD"
},
{
"description": "period when consumers are traveling.\n* It can be a month only. \n* ISO format must be used - e.g. 2015-05. \n* Period ranges are not supported. \n* Only periods from 2011-01 up to previous month are valid. \n* Future dates are not supported.\n",
"in": "query",
"name": "period",
"required": true,
"type": "string",
"x-example": "2017-08"
},
{
"default": 10,
"description": "maximum number of destinations in the response. Default value is 10 and maximum value is 50.",
"format": "integer",
"in": "query",
"name": "max",
"required": false,
"type": "number"
},
{
"$ref": "#/parameters/fields"
},
{
"$ref": "#/parameters/pageLimit"
},
{
"$ref": "#/parameters/pageOffset"
},
{
"$ref": "#/parameters/sort"
}
],
"responses": {
"200": {
"$ref": "#/responses/air-traffic"
},
"400": {
"$ref": "#/responses/400"
},
"default": {
"$ref": "#/responses/500"
}
},
"summary": "Returns a list of air traffic reports.",
"tags": [
"air-traffic"
]
}
}
},
"definitions": {
"Air_Traffic": {
"properties": {
"analytics": {
"$ref": "#/definitions/Analytics"
},
"destination": {
"description": "IATA code of the destination city - [IATA table codes](http://www.iata.org/publications/Pages/code-search.aspx)",
"example": "WAS",
"type": "string"
},
"subType": {
"type": "string"
},
"type": {
"example": "air-traffic",
"type": "string"
}
}
},
"Analytics": {
"properties": {
"flights": {
"$ref": "#/definitions/Flights"
},
"travelers": {
"$ref": "#/definitions/Travelers"
}
}
},
"Collection_Meta": {
"properties": {
"count": {
"example": 1,
"type": "integer"
},
"links": {
"example": {
"self": "https://test.api.amadeus.com/v1/area/resources?param=value"
},
"properties": {
"first": {
"example": "https://test.api.amadeus.com/v1/area/resources?...",
"format": "uri",
"type": "string"
},
"last": {
"example": "https://test.api.amadeus.com/v1/area/resources?...",
"format": "uri",
"type": "string"
},
"next": {
"example": "https://test.api.amadeus.com/v1/area/resources?...",
"format": "uri",
"type": "string"
},
"previous": {
"example": "https://test.api.amadeus.com/v1/area/resources?...",
"format": "uri",
"type": "string"
},
"self": {
"example": "https://test.api.amadeus.com/v1/area/resources?...",
"format": "uri",
"type": "string"
},
"up": {
"example": "https://test.api.amadeus.com/v1/area/resources?...",
"format": "uri",
"type": "string"
}
},
"title": "CollectionLinks"
}
},
"title": "Collection_Meta"
},
"Error_400": {
"example": {
"errors": [
{
"code": 477,
"detail": "invalid query parameter format",
"source": {
"example": "CDG",
"parameter": "airport"
},
"status": 400,
"title": "INVALID FORMAT"
}
]
},
"properties": {
"errors": {
"items": {
"$ref": "#/definitions/Issue"
},
"type": "array"
}
},
"required": [
"errors"
]
},
"Error_500": {
"example": {
"errors": [
{
"code": 141,
"status": 500,
"title": "SYSTEM ERROR HAS OCCURRED"
}
]
},
"properties": {
"errors": {
"items": {
"$ref": "#/definitions/Issue"
},
"type": "array"
}
},
"required": [
"errors"
]
},
"Flights": {
"properties": {
"score": {
"description": "Approximate score for ranking purposes calculated based on number of flights from / to the airport or city",
"example": 56,
"format": "integer",
"type": "number"
}
}
},
"Issue": {
"properties": {
"code": {
"description": "an application-specific error code",
"format": "int64",
"type": "integer"
},
"detail": {
"description": "explanation of the error",
"type": "string"
},
"source": {
"description": "an object containing references to the source of the error",
"maxProperties": 1,
"properties": {
"example": {
"description": "a string indicating an example of the right value",
"type": "string"
},
"parameter": {
"description": "a string indicating which URI query parameter caused the issue",
"type": "string"
},
"pointer": {
"description": "a JSON Pointer [RFC6901] to the associated entity in the request document",
"type": "string"
}
},
"title": "Issue_Source",
"type": "object"
},
"status": {
"description": "the HTTP status code applicable to this error",
"type": "integer"
},
"title": {
"description": "a short summary of the error",
"type": "string"
}
}
},
"Travelers": {
"properties": {
"score": {
"description": "Approximate score for ranking purposes calculated based on number of travelers in the location.",
"example": 68,
"format": "integer",
"type": "number"
}
}
}
},
"x-generatedAt": "2020-07-23T09:58:30.654Z"
}