openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 135 kB

JSON

{"openapi":"3.0.0","info":{"contact":{"name":"Amadeus Innovation and Research","url":"https://sandbox.amadeus.com"},"license":{"name":"Amadeus Travel Innovation Sandbox License","url":"https://sandbox.amadeus.com/terms-use"},"title":"Amadeus Travel Innovation Sandbox","version":"1.2","x-logo":{"url":"https://sandbox.amadeus.com/sites/default/files/amadeus_logo_US_registered_0_0.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/amadeus-travel-innovation-sandbox/sandbox-content/master/swagger.yml","version":"2.0"}],"x-providerName":"amadeus.com"},"security":[{"apikey":[]}],"paths":{"/airports/autocomplete":{"get":{"description":"Using the term parameter and given the start of any word in an airport's official name, a city name, or the start of an <a href=\"https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code\">IATA code</a>, this API provides the full name and IATA location code of the city or airport, for use in flight searches. Only major cities and civilian airports with several commercial flights per week are included by default. The response provides up to 20 possible matches, sorted by importance, in a <a href=\"http://jqueryui.com/autocomplete/\">JQuery UI Autocomplete</a> compatible format. <a href=\"https://github.com/amadeus-travel-innovation-sandbox/sandbox-content/blob/master/airport-autocomplete-template.html\">This sample implementation</a> using JQuery UI may help. This API uses data from the <a href=\"https://github.com/opentraveldata/opentraveldata/blob/master/opentraveldata/optd_por_public.csv\">OpenTravelData</a> project.\n \nBy only using the country parameter, this API is also able to find all the IATA location codes associated with a country. Both term and country parameters can be used together to filter the results accordingly. \n\nThe value returned is the IATA location code. The label returned is always in UTF-8 format, with the airport official name (which is often in the native language), in the format of English City Name (if not already included in the airport name).\n","operationId":"Airport Autocomplete","parameters":[{"description":"Search keyword that should represent the start of a word in a city or airport name.","in":"query","name":"term","required":true,"schema":{"type":"string","default":"Ban"}},{"description":"Identified a country based of a <a href=\"https://en.wikipedia.org/wiki/ISO_3166-2#Current_codes\">ISO 3166-1 alpha-2 code</a>","in":"query","name":"country","required":false,"schema":{"type":"string","default":"US"}},{"description":"Boolean to include or not all airports, no matter their traffic rank. False by default, to only display relevant airports.","in":"query","name":"all_airports","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AirportAutocompleteResponse"},"type":"array"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Airport Autocomplete - Find an IATA location code for flight search based on a city or airport name using the term parameter. By only using the country parameter, this API is also able to find all the IATA location codes associated with a country. Both term and country parameters can be used together to filter the results accordingly. The API is fully JQuery-Autocomplete compatible to enable you to quickly build a drop-down list for your users to find the right airport easily."}},"/airports/nearest-relevant":{"get":{"description":"This service gives the most relevant airports in a radius of 500 km around the given coordinates. The relevance of an airport is computed by dividing the number of airport movements (take offs and landings) by the distance from the point. This causes the relevance of an airport to increase exponentially as you approach it.\n\nTo minimize response time, all distances are computed as a <a href=\"http://en.wikipedia.org/wiki/Great-circle_distance\">great-circle distance</a> from the provided coordinates to the airport coordinates, and thus do not take into account traffic conditions, international boundaries, mountains, water, or other elements that might make the a nearby airport hard to reach.\n\nOnly civilian airports with at least several commercial flights per week are included in the results.\n\nThe result is a list of airports sorted by decreasing relevance. It always contains the nearest airport with significant commercial traffic. You can freely download the <a href=\"https://github.com/opentraveldata/opentraveldata/blob/master/opentraveldata/optd_por_public.csv\">point of reference information</a> used by this API from the <a href=\"https://github.com/opentraveldata/opentraveldata\">Open Travel Data</a> project.\n","operationId":"Nearest Relevant Airport","parameters":[{"description":"Latitude location to be at the center of your search circle.","in":"query","name":"latitude","required":true,"schema":{"type":"string","default":"46.6734"}},{"description":"Longitude location to be at the center of your search circle.","in":"query","name":"longitude","required":true,"schema":{"type":"string","default":"-71.7412"}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NearestAirport"},"type":"array"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Nearest Relevant Airport - Find the most useful nearby airport to a given location."}},"/cars/search-airport":{"get":{"description":"With this API you can find out the price and type of car, for all car rental providers, near a specified airport.\n\nYou can quickly see the locations of car providers near a given airport, and what cars are available to rent, and at what prices. This API is based on our car pricing service that gets live availability from car providers, and is used to power a variety of airline and travel agency websites.\n \nResults are validated from car providers, and thus response times may take up to 10 seconds (response times are typically about 5s), and the number of concurrent calls is throttled per user to avoid flooding our provider's systems. However, this means the final result is guaranteed to be live and accurate.\n\nThe configuration of this API allows search for car rentals in the rental location where the car is picked up (at the start of the rental), is the same as the one where it will be dropped off.\n","operationId":"Car Rental Airport Search","parameters":[{"description":"The <a href=\"https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code\">IATA code</a> of the airport at which the car will be rented.","in":"query","name":"location","required":true,"schema":{"type":"string","default":"NCE"}},{"description":"Date on which the car rental will be collected from the car rental location. If no time is provided, a default value of 09:00 is used. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date.","in":"query","name":"pick_up","required":true,"schema":{"type":"string","default":"2017-08-07"}},{"description":"Date at which the car rental will end and the car will be returned to the rental location. If no time is provided, a default value of 17:00 is used.","in":"query","name":"drop_off","required":true,"schema":{"type":"string","default":"2017-08-08"}},{"description":"The preferred language of the content related to each car rental. Content will be returned in this language if available.","in":"query","name":"lang","required":false,"schema":{"type":"string","default":"EN"}},{"description":"The preferred <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">currency</a> to use when displaying prices and rates related to the car rental.","in":"query","name":"currency","required":false,"schema":{"type":"string","default":"USD"}},{"description":"2 character car rental provider code. You may provide this parameter more than once. ","in":"query","name":"provider","required":false,"schema":{"type":"string","default":"ZI"}},{"description":"Allows to request specific rate types.","in":"query","name":"rate_class","required":false,"schema":{"type":"string","default":"ALL"}},{"description":"Qualifies the rate depending on the pickup date and the rental duration.","in":"query","name":"rate_plan","required":false,"schema":{"type":"string","default":"DAILY"}},{"description":"Defines the types of rates to be returned in the output","in":"query","name":"rate_filter","required":false,"schema":{"type":"string","enum":["AVAILABLE","ESTIMATED","ALL"],"default":"ESTIMATED"}},{"description":"Specifies the type of vehicle to be rented. If selected, the results set will include only vehicles that match these type descriptions. The enumerations above correspond to ACRISS Pseudo Codes, and you may also provide an ACRISS pseudo code directly. If specifying a vehicle-specific ACRISS code, you may provide this parameter up to 3 times.","in":"query","name":"vehicle","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarSearchResponse"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Car Rental Airport Search - Find car rental providers and rates when you provide an airport code, as well as the pick-up and drop-off dates. Optional parameters such as currency and rental provider codes are also available and can be used to narrow down the results. This API is an ideal pairing with the flight and hotel search to provide ground transportation options at the destination."}},"/cars/search-circle":{"get":{"description":"With this API you can find out the price and type of car, for all car rental providers, in a specified geographical location.\n\nYou can quickly see the locations of car providers near a given point, and what cars are available to rent, and at what prices. This API is based on our car pricing service that gets live availability from car providers, and is used to power a variety of airline and travel agency websites.\n \nResults are validated from car providers, and thus response times may take up to 10 seconds (response times are typically about 5s), and the number of concurrent calls is throttled per user to avoid flooding our provider's systems. However, this means the final result is guaranteed to be live and accurate.\n\nThe configuration of this API allows search for car rentals in the rental location where the car is picked up (at the start of the rental), is the same as the one where it will be dropped off. \n","operationId":"Car Rental Geosearch","parameters":[{"description":"Latitude of the center of the search.","in":"query","name":"latitude","required":true,"schema":{"type":"number","default":35.1504}},{"description":"Longitude of the center of the search.","in":"query","name":"longitude","required":true,"schema":{"type":"number","default":-114.57632}},{"description":"Radius around the center to look for hotels in kilometers (km).","in":"query","name":"radius","required":true,"schema":{"type":"integer","default":42}},{"description":"Date on which the car rental will be collected from the car rental location. If no time is provided, a default value of 09:00 is used. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date.","in":"query","name":"pick_up","required":true,"schema":{"type":"string","default":"2017-08-07"}},{"description":"Date at which the car rental will end and the car will be returned to the rental location. If no time is provided, a default value of 17:00 is used.","in":"query","name":"drop_off","required":true,"schema":{"type":"string","default":"2017-08-08"}},{"description":"The preferred language of the content related to each car rental. Content will be returned in this language if available.","in":"query","name":"lang","required":false,"schema":{"type":"string","default":"EN"}},{"description":"The preferred <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">currency</a> to use when displaying prices and rates related to the car rental.","in":"query","name":"currency","required":false,"schema":{"type":"string","default":"USD"}},{"description":"2 character car rental provider code. You may provide this parameter more than once. ","in":"query","name":"provider","required":false,"schema":{"type":"string","default":"ZI"}},{"description":"Allows to request specific rate types.","in":"query","name":"rate_class","required":false,"schema":{"type":"string","default":"ALL"}},{"description":"Qualifies the rate depending on the pickup date and the rental duration.","in":"query","name":"rate_plan","required":false,"schema":{"type":"string","default":"DAILY"}},{"description":"Defines the types of rates to be returned in the output","in":"query","name":"rate_filter","required":false,"schema":{"type":"string","enum":["AVAILABLE","ESTIMATED","ALL"],"default":"ESTIMATED"}},{"description":"Specifies the type of vehicle to be rented. If selected, the results set will include only vehicles that match these type descriptions. The enumerations above correspond to ACRISS Pseudo Codes, and you may also provide an ACRISS pseudo code directly. If specifying a vehicle-specific ACRISS code, you may provide this parameter up to 3 times.","in":"query","name":"vehicle","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarSearchResponse"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Car Rental Geosearch - Locate car rental providers and available vehicles when you define a circular area with one coordinate and radius, as well as the pick-up and drop-off dates. Optional parameters such as currency and rental provider codes are also available and can be used to narrow down the results. This API is an ideal pairing with the flight and hotel search to provide ground transportation options at the destination."}},"/flights/affiliate-search":{"get":{"description":"The Flight Affiliate Search API combines Amadeus' flight search technology with Travel Audience's Connect API partners to provide a unique flight search, where all results come with deep-links to book the flight at a partner's website. The API will let you easily provide the traveler with a path to book flights from your application.\nTravel Audience Connect partners include\n<ul>\n <li><a href=\"http://www.cityjet.com/\">CityJet</a>, <a href=\"https://www.aireuropa.com/en/flights\">Air Europa</a> and <a href=\"http://www.flytap.com/\">TAP</a> in Western Europe,</li>\n <li><a href=\"http://uralairlines.com/\">Ural Airlines</a> in Russia, </li>\n <li><a href=\"http://www.avianca.com.br/\">Avianca Brazil</a> and</li>\n <li><a href=\"http://www.jal.com/\">JAL</a> in East Asia</li>\n</ul>\n\nOnly Travel Audience Connect partner airlines are searched. For an up-to-date list of routes, see the route maps on each partners respective websites above. You can earn commission using the deep links provided in the search results if you sign up for an account at <a href=\"http://connect.travelaudience.com/\">connect.travelaudience.com</a>.\n","operationId":"Flight Affiliate Search","parameters":[{"description":"City code from which the traveler will depart. See the location and airport interfaces for more information.","in":"query","name":"origin","required":true,"schema":{"type":"string","default":"LON"}},{"description":"<a href=\"https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code\">IATA code</a> of the city to which the traveler is going","in":"query","name":"destination","required":true,"schema":{"type":"string","default":"DUB"}},{"description":"The date on which the traveler will depart from the origin to go to the destination. The maximum scope for a date range is 2 days, for a larger scope, use the Extensive Search! ","in":"query","name":"departure_date","required":true,"schema":{"type":"string","default":"2017-08-25"}},{"description":"The date on which the traveler will depart from the destination to return to the origin. If this parameter is not specified, the search will find only one-way trips. If this, or the return_by parameter are specified, only return trips are found","in":"query","name":"return_date","required":false,"schema":{"type":"string","default":"2017-08-28"}},{"description":"The number of adult (age 12 and over) passengers traveling on this flight.","in":"query","name":"adults","required":false,"schema":{"type":"integer","default":1}},{"description":"The number of child (younger than age 12 on date of departure) passengers traveling on this flight who will each have their own separate seat","in":"query","name":"children","required":false,"schema":{"type":"integer","default":0}},{"description":"The number of infant (younger than age 2 on date of departure) passengers traveling on this flight. Infants travel in the lap of an adult passenger, and thus the number of infants must not exceed the number of adults.","in":"query","name":"infants","required":false,"schema":{"type":"integer","default":0}},{"description":"If specified, all results will include at least one flight where one or more of these airlines is the marketing carrier. Airlines are specified using <a href=\"https://en.wikipedia.org/wiki/Airline_codes\"><a href=\"https://en.wikipedia.org/wiki/Airline_codes\">IATA airline code</a>s</a>","in":"query","name":"include_merchants","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"If specified, no results will include any flights where any of these airlines is the marketing carrier. Airlines are specified using <a href=\"https://en.wikipedia.org/wiki/Airline_codes\"><a href=\"https://en.wikipedia.org/wiki/Airline_codes\">IATA airline code</a>s</a>","in":"query","name":"exclude_merchants","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Maximum price of trips to find in the result set, in USD (US dollars) unless some other currency code is specified. By default, no limit is applied","in":"query","name":"max_price","required":false,"schema":{"type":"integer","default":980}},{"description":"The preferred <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">currency</a> for the results","in":"query","name":"currency","required":false,"schema":{"type":"string","default":"EUR"}},{"description":"Setting this to true will show mobile web deeplinks ","in":"query","name":"mobile","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateSearchResponse"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Flight Affiliate Search - Use Travel Audience Connect's affiliate network API to search flights from our list of partners and provides deep-links to allow the user to book directly on the airline website."}},"/flights/extensive-search":{"get":{"description":"The Extensive Flight Search allows you to find the prices of one-way or return flights between two airports over a large number of dates, and for a large variety of stay durations. The search doesn't return exact itineraries, but rather tells you the best price for a flight on a given day, for a stay of a given duration.\n\nThe search is based on our Extreme Search platform, which continually caches a large number of flight search results from a list of origin cities to a variety of destinations. Since it's a cached search, the response time is fast, but not all origin airports are available. Here is <a href=\"https://github.com/amadeus-travel-innovation-sandbox/sandbox-content/blob/master/flight-search-cache-origin-destination.csv\">a list of the currently supported origin-destination IATA location pairs</a>. We try to keep this list as fresh as possible for you, but be aware that it may not always be exactly up-to-date and it can change without warning.\n\nThat said, a price graph like this provides a powerful bargin shopping tool - allowing travelers with flexible itineraries to identify days on which they can get the cheapest flights to their destinations.\n","operationId":"Flight Extensive Search","parameters":[{"description":"<a href=\"https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code\">IATA code</a> of the city from which the traveler will depart. See the location and airport interfaces for more information.","in":"query","name":"origin","required":true,"schema":{"type":"string","default":"FRA"}},{"description":"<a href=\"https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code\">IATA code</a> of the city to which the traveler is going","in":"query","name":"destination","required":true,"schema":{"type":"string","default":"LON"}},{"description":"Range of dates between which the traveler could depart. Dates are specified in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> yyyy-MM-dd date format. Ranges are inclusive and ranges of months will apply from the start to the end of the month. If just a single date is specified, only that date will be searched. By default, the date range starts today and applies up to 361 in the future is applied. Past dates are generally not supported, future dates should be in the next 361 days, although results start to become sparse after about 6 months in the future, as airlines may still be defining their schedules. The default is to search all future dates available. \n","in":"query","name":"departure_date","required":false,"schema":{"type":"string","default":"2017-08-16--2017-08-26"}},{"description":"When set to true, the query will be for a single trip from the origin to the destination. When this parameter is not provided, or is set to false, the query is for a round trip from the origin to the destination and back again.","in":"query","name":"one-way","required":false,"schema":{"type":"boolean","default":false}},{"description":"The allowed duration or range of durations of the trip, in days. This parameter must not be set if the one-way parameter is set to true.","in":"query","name":"duration","required":false,"schema":{"type":"string","default":"1--15"}},{"description":"Limit the search to results that do not require the passenger to change plane?","in":"query","name":"direct","required":false,"schema":{"type":"boolean","default":false}},{"description":"Maximum price of trips to find in the result set, in the currency specified for this origin and destination pair in the cache contents spreadsheet. So, for example, if the origin is NYC, and the max price is 400, this means 400 USD. If the origin is PAR, and the max price is 400, this means 400 EUR. By default, no limit is applied","in":"query","name":"max_price","required":false,"schema":{"type":"string","default":"950"}},{"description":"Specifies the granularity of results to be found. DAY is the default when one-way is true finds a result for departure date in the date range. STAY is the default otherwise and finds all round trip permutations for this route withim the given date range. DESTINATION finds one result, only the cheapest price for this route over the provided date range. WEEK finds the cheapest result for every week in the date range. Note that specifying a small granularity but a large search scope may result in a huge output. For some very large outputs, the API may refuse to provide a result.","in":"query","name":"aggregation_mode","required":false,"schema":{"type":"string","default":"DAY"}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtremeSearchResponse"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Flight Extensive Search - Build travel searches based on very flexible and open range of dates. You can use it to answer questions such as \"When is the best date to fly...\". It's built on Amadeus' Featured Results technology, which returns thousands of results (prices, itineraries and dates) in a matter of milliseconds. Results are available over half a calendar year with a 1 to 15 day stay duration"}},"/flights/inspiration-search":{"get":{"description":"The Inspiration Flight Search allows you to find the prices of one-way and return flights from an origin city without necessarily having a destination, or even a flight date, in mind. The search doesn't return a distinct set of price options, but rather, can tell you the price of flying from a given city to some destination, for a trip of a given duration, that falls within a given date range.\n\nThe search is based on our Extreme Search platform, which continually caches a large number of flight search results from a list of origin cities to a variety of destinations. Since it's a cached search, the response time is fast, but not all origin airports are available. Here is <a href=\"https://github.com/amadeus-travel-innovation-sandbox/sandbox-content/blob/master/flight-search-cache-origin-destination.csv\">a list of the currently supported origin-destination IATA location pairs</a>. We try to keep this list as fresh as possible for you, but be aware that it may not always be exactly up-to-date and it can change without warning.\n\nDespite this limitation don't underestimate the power of this API. Thanks to its quick response speed you can easily pair it with other APIs to provide a low fare and inspiration for any destination. For example, you can could combine it with a event search API and suggest a total price to see go and see an concert or a game in a selection of cities.\n","operationId":"Flight Inspiration Search","parameters":[{"description":"<a href=\"https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code\">IATA code</a> of the city from which the traveler will depart. See the location and airport interfaces for more information.","in":"query","name":"origin","required":true,"schema":{"type":"string","default":"NYC"}},{"description":"<a href=\"https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code\">IATA code</a> of the city to which the traveler is going","in":"query","name":"destination","required":false,"schema":{"type":"string","default":"LAX"}},{"description":"Range of dates between which the traveler could depart. Dates are specified in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> yyyy-MM-dd date format. Ranges are inclusive and ranges of months will apply from the start to the end of the month. If just a single date is specified, only that date will be searched. By default, the date range starts today and applies up to 361 in the future is applied. Past dates are generally not supported, future dates should be in the next 361 days, although results start to become sparse after about 6 months in the future, as airlines may still be defining their schedules. The default is to search all future dates available.","in":"query","name":"departure_date","required":false,"schema":{"type":"string","default":"2017-08-16--2017-08-26"}},{"description":"When set to true, the query will be for a single trip from the origin to the destination. When this parameter is not provided, or is set to false, the query is for a round trip from the origin to the destination and back again.","in":"query","name":"one-way","required":false,"schema":{"type":"boolean","default":false}},{"description":"The allowed duration or range of durations of the trip, in days. This parameter must not be set if the one-way parameter is set to true.","in":"query","name":"duration","required":false,"schema":{"type":"string","default":"1--15"}},{"description":"Limit the search to results that do not require the passenger to change plane?","in":"query","name":"direct","required":false,"schema":{"type":"boolean","default":false}},{"description":"Maximum price of trips to find in the result set, in the currency specified for this origin and destination pair in the cache contents spreadsheet. So, for example, if the origin is NYC, and the max price is 400, this means 400 USD. If the origin is PAR, and the max price is 400, this means 400 EUR. By default, no limit is applied","in":"query","name":"max_price","required":false,"schema":{"type":"string","format":"Integer"}},{"description":"Specifies the granularity of results to be found. DESTINATION is the default and finds one result per city. COUNTRY finds one result per country, DAY finds on result for every day in the date range, WEEK finds one result for every week in the date range. Note that specifying a small granularity but a large search scope may result in a huge output. For some very large outputs, the API may refuse to provide a result.","in":"query","name":"aggregation_mode","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtremeSearchResponse"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Flight Inspiration Search - Go beyond the traditional search by origin, destination and dates to meet the needs of travelers looking for suggestions and a search experience that reflects the way they choose their trip. This can help you answer the question \"Where can I go within a given travel budget?\""}},"/flights/low-fare-search":{"get":{"description":"This is the low fare search engine Amadeus uses to retrieve the best price for flights, based on our latest Master Pricer Travel Board technology. This document describes how to make a low fare search and how to handle the returned messages.\n\nThe message is composed of multiple results for given request. A result is defined by a unique combination of price, tax, passenger type, fare type, cabin, and availability for each requested segment. \n\nA result is then composed of single or multiple itineraries. Each itinerary is composed of an outbound leg, and, if a return date was specified, an inbound leg. Each leg is composed of a list of one or more flights, that the traveller will be required to take in order to get from the origin airport to the destination airport.\n","operationId":"Flight Low-Fare Search","parameters":[{"description":"City code from which the traveler will depart. See the location and airport interfaces for more information.","in":"query","name":"origin","required":true,"schema":{"type":"string","default":"BOS"}},{"description":"<a href=\"https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code\">IATA code</a> of the city to which the traveler is going","in":"query","name":"destination","required":true,"schema":{"type":"string","default":"LON"}},{"description":"The date on which the traveler will depart from the origin to go to the destination. You can specify a date range of up to 2 days. For a larger date range, use the Extensive Search. Dates are specified in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> yyyy-MM-dd date format and separated by --.","in":"query","name":"departure_date","required":true,"schema":{"type":"string","format":"string","default":"2017-08-25"}},{"description":"The date on which the traveler will depart from the destination to return to the origin. If this parameter is not specified, the search will find only one-way trips. If this, or the return_by parameter are specified, only return trips are found. You can specify a date range of up to 2 days.","in":"query","name":"return_date","required":false,"schema":{"type":"string","default":"2017-08-28"}},{"description":"The datetime by which the outbound flight should arrive, based on local time at the destination airport. Date-times are specified in the <a href=\"https://en.wikipedia.org/wiki/ISO_8601\">ISO 8601</a> yyyy-MM-ddTHH:mm date format","in":"query","name":"arrive_by","required":false,"schema":{"type":"string","default":"2017-08-25T16:00"}},{"description":"The time by which the inbound flight should arrive, based on local time at the airport specified as the origin parameter","in":"query","name":"return_by","required":false,"schema":{"type":"string","default":"2017-08-28T08:00"}},{"description":"The number of adult (age 12 and over) passengers traveling on this flight.","in":"query","name":"adults","required":false,"schema":{"type":"integer","default":1}},{"description":"The number of child (younger than age 12 on date of departure) passengers traveling on this flight who will each have their own separate seat","in":"query","name":"children","required":false,"schema":{"type":"integer","default":0}},{"description":"The number of infant (younger than age 2 on date of departure) passengers traveling on this flight. Infants travel in the lap of an adult passenger, and thus the number of infants must not exceed the number of adults.","in":"query","name":"infants","required":false,"schema":{"type":"integer","default":0}},{"description":"If specified, all results will include at least one flight where one or more of these airlines is the marketing carrier. This behaves as an OR function. Airlines are specified using <a href=\"https://en.wikipedia.org/wiki/Airline_codes\"><a href=\"https://en.wikipedia.org/wiki/Airline_codes\">IATA airline code</a>s</a>.","in":"query","name":"include_airlines","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"If specified, no results will include any flights where any of these airlines is the marketing carrier. Airlines are specified using <a href=\"https://en.wikipedia.org/wiki/Airline_codes\"><a href=\"https://en.wikipedia.org/wiki/Airline_codes\">IATA airline code</a>s</a>.","in":"query","name":"exclude_airlines","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Setting this to true will find only flights that do not require the passenger to change from one flight to another","in":"query","name":"nonstop","required":false,"schema":{"type":"boolean","default":false}},{"description":"Maximum price of trips to find in the result set, in USD (US dollars) unless some other currency code is specified. By default, no limit is applied","in":"query","name":"max_price","required":false,"schema":{"type":"integer","default":980}},{"description":"The preferred <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">currency</a> for the results","in":"query","name":"currency","required":false,"schema":{"type":"string","default":"USD"}},{"description":"Searches for results where the majority of the itinerary flight time should be in a the specified cabin class or higher","in":"query","name":"travel_class","required":false,"schema":{"type":"string","default":"ECONOMY"}},{"description":"The number of results to display. This will not be strictly interpreted but used as a guideline to display a useful number of results. By default, the number of results is dynamically determined. A maximum of 250 results will be displayed.","in":"query","name":"number_of_results","required":false,"schema":{"type":"integer","default":5}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LowFareSearchResponse"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Flight Low-Fare Search - Find the cheapest one way or return itineraries and fares between two airports at specific dates."}},"/hotels/search-airport":{"get":{"description":"A fast Hotel shopping API to see which hotels are available in a given area, on a given day and displays their lowest prices. With this API you can find out the price of the cheapest daily rate for all hotels near a given airport.\n\nThis API allows you to quickly see the locations of hotels near a given airport, and what prices in that area look like. Note that hotel images are not available to users outside of Amadeus, as we are not licensed to redistribute them. The API is based on our high-speed hotel pricing cache, which is also used to power the <a href=\"https://hotelsearchengine.amadeus.com/\">Amadeus Hotel Search Engine</a> application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.\n","operationId":"Hotel Airport Search","parameters":[{"description":"<a href=\"https://en.wikipedia.org/wiki/International_Air_Transport_Association_airport_code\">IATA airport code</a> for hotel availability is required requested.","in":"query","name":"location","required":true,"schema":{"type":"string","default":"BOS"}},{"description":"Date on which the guest will begin their stay in the hotel. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date.","in":"query","name":"check_in","required":true,"schema":{"type":"string","default":"2017-08-15"}},{"description":"Date on which the guest will end their stay in the hotel.","in":"query","name":"check_out","required":true,"schema":{"type":"string","default":"2017-08-16"}},{"description":"Radius around the center to look for hotels in kilometers (km).","in":"query","name":"radius","required":false,"schema":{"type":"integer","default":42}},{"description":"The preferred language of the content related to each hotel. Content will be returned in this language if available.","in":"query","name":"lang","required":false,"schema":{"type":"string","default":"EN"}},{"description":"The preferred <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">currency</a> for the results","in":"query","name":"currency","required":false,"schema":{"type":"string","default":"USD"}},{"description":"Narrows the hotel search to a given hotel provider. The hotel chain is indicated by the first two characters of the property code.","in":"query","name":"chain","required":false,"schema":{"type":"string","default":"6C"}},{"description":"The maximum amount per night that any hotel in the shopping response should cost. This is calculated by dividing the total price of the stay for the given dates by the number of nights specified falling between the check_in and check_out dates.","in":"query","name":"max_rate","required":false,"schema":{"type":"number","default":500}},{"description":"The maximum number of hotels to return in the results set. Hotels are ordered by total price, so if more than the given maximum number of hotels are available, only the cheapest options are returned.","in":"query","name":"number_of_results","required":false,"schema":{"type":"integer","default":20}},{"description":"This option if enabled will return all hotel room rates, not just the lowest room rate. Note: This will have an impact on the response time due to the larger messages returned.","in":"query","name":"all_rooms","required":false,"schema":{"type":"boolean","default":false}},{"description":"This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)","in":"query","name":"show_sold_out","required":false,"schema":{"type":"boolean","default":false}},{"description":"Hotel <a href=\"hotels-api-supported-amenities-filter\">amenities filter</a> to search narrow down hotels with certain amenities. For example&colon; amenity=POOL. (Note: multiple amenities can be used in searches: amenity=PARKING&amenity=RESTAURANT&amenity=PETS_ALLOWED).\n","in":"query","name":"amenity","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelSearchResponse"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Hotel Airport Search - Locate the cheapest available rooms near a given airport, for a given stay period. This API is ideal if you want to connect flight and hotels. Provide an IATA airport code, as well as the check-in and check-out dates, and get a list of up to 140 properties (names, codes, image, amenities) with their locations and rates. Optional parameters such as currency and maximum rates, amenities or hotel chain codes are also available and can be used to narrow down the results. More optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms."}},"/hotels/search-box":{"get":{"description":"A fast Hotel shopping API to see which hotels are available in a given area, on a given day and displays their lowest prices. With this API you can find out the price of the cheapest daily rate for all hotels within a specified geographical region.\n\nThis API allows you to quickly see the hotel locations in a region, and what prices in that area look like, as well as the check-in and check-out dates, and get a list of up to 140 properties (names, codes, image, amenities) with their locations and rates. Optional parameters such as currency and maximum rates, amenities or hotel chain codes are also available and can be used to narrow down the results. More optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms.\n \nThe API is based on our high-speed hotel pricing cache, which is also used to power the <a href=\"https://hotelsearchengine.amadeus.com/\">Amadeus Hotel Search Engine</a> application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.\n","operationId":"Hotel Geosearch by box","parameters":[{"description":"The coordinates of the south-west corner of the search box.","in":"query","name":"south_west_corner","required":true,"schema":{"type":"string","default":"38.8675,-77.1457"}},{"description":"The coordinates of the north-east corner of the search box.","in":"query","name":"north_east_corner","required":true,"schema":{"type":"string","default":"38.9072,-77.0632"}},{"description":"Date on which the guest will begin their stay in the hotel. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date.","in":"query","name":"check_in","required":true,"schema":{"type":"string","default":"2017-08-15"}},{"description":"Date on which the guest will end their stay in the hotel.","in":"query","name":"check_out","required":true,"schema":{"type":"string","default":"2017-08-16"}},{"description":"The preferred language of the content related to each hotel. Content will be returned in this language if available.","in":"query","name":"lang","required":false,"schema":{"type":"string","default":"EN"}},{"description":"The preferred <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">currency</a> for the results","in":"query","name":"currency","required":false,"schema":{"type":"string","default":"USD"}},{"description":"Narrows the hotel search to a given hotel provider. The hotel chain is indicated by the first two characters of the property code.","in":"query","name":"chain","required":false,"schema":{"type":"string","default":"6C"}},{"description":"The maximum amount per night that any hotel in the shopping response should cost. This is calculated by dividing the total price of the stay for the given dates by the number of nights specified falling between the check_in and check_out dates.","in":"query","name":"max_rate","required":false,"schema":{"type":"number","default":500}},{"description":"The maximum number of hotels to return in the results set. Hotels are ordered by total price, so if more than the given maximum number of hotels are available, only the cheapest options are returned.","in":"query","name":"number_of_results","required":false,"schema":{"type":"integer","default":20}},{"description":"This option if enabled will return all hotel room rates, not just the lowest room rate. Note: This will have an impact on the response time due to the larger messages returned.","in":"query","name":"all_rooms","required":false,"schema":{"type":"boolean","default":false}},{"description":"This option if enabled will return hotel names and addresses even if rooms are sold out (closed properties)","in":"query","name":"show_sold_out","required":false,"schema":{"type":"boolean","default":false}},{"description":"Hotel <a href=\"hotels-api-supported-amenities-filter\">amenities filter</a> to search narrow down hotels with certain amenities. For example&colon; amenity=POOL. (Note: multiple amenities can be used in searches: amenity=PARKING&amenity=RESTAURANT&amenity=PETS_ALLOWED).\n","in":"query","name":"amenity","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Valid Search Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelSearchResponse"}}}},"default":{"description":"Client or server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Hotel Geosearch by box - Locate the cheapest available rooms within a given rectangular region for a given stay period. It's ideal for displaying results on a map."}},"/hotels/search-circle":{"get":{"description":"A fast Hotel shopping API to see which hotels are available in a given area, on a given day and displays their lowest prices. With this API you can find out the price of the cheapest daily rate for all hotels within a specified radius of a point.\n\nThis API allows you to quickly see the hotel locations in a region, and what prices in that area look like, as well as the check-in and check-out dates, and get list of up to 140 properties (names, codes, image, amenities) with their locations and rates. Optional parameters such as currency and maximum rates, amenities or hotel chain codes are also available and can be used to narrow down the results. More optional parameters such as show_sold_out & rooms can be used to show sold out rooms and all available rooms. \n\nThe API is based on our high-speed hotel pricing cache, which is also used to power the <a href=\"https://hotelsearchengine.amadeus.com/\">Amadeus Hotel Search Engine</a> application. Results are returned very quickly, response times are generally under 2s. Our cache has great global coverage and is constantly refreshed with the latest prices.\n","operationId":"Hotel Geosearch by circle","parameters":[{"description":"Latitude of the center of the search.","in":"query","name":"latitude","required":true,"schema":{"type":"number","default":36.0857}},{"description":"Longitude of the center of the search.","in":"query","name":"longitude","required":true,"schema":{"type":"number","default":-115.1541}},{"description":"Radius around the center to look for hotels in kilometers (km).","in":"query","name":"radius","required":true,"schema":{"type":"integer","default":42}},{"description":"Date on which the guest will begin their stay in the hotel. Past availability is not displayed, future availability becomes less useful from about 6 months from the current date.","in":"query","name":"check_in","required":true,"schema":{"type":"string","default":"2017-08-15"}},{"description":"Date on which the guest will end their stay in the hotel.","in":"query","name":"check_out","required":true,"schema":{"type":"string","default":"2017-08-16"}},{"description":"The preferred language of the content related to each hotel. Content will be returned in this language if available.","in":"query","name":"lang","required":false,"schema":{"type":"string","default":"EN"}},{"description":"The preferred <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">currency</a> for the results","in":"query","name":"currency","required":false,"schema":{"type":"string","default":"USD"}},{"description":"Narrows the hotel search to a given hotel provider. The hotel chain is indicated by the first two characters of the property code.","in":"query","name":"chain","required":false,"schema":{"type":"string","default":"6C"}},{"description":"The maximum amount per night that any hotel in the shopping response should cost. This is calculated by dividing the total price of the stay for the given dates by the number of nights specified falling between the check_in and check_out dates.","in":"query","name":"max_rate","required":false,"schema":{"type":"number","default":500}},{"description":"The maximum number of hotels to return in the results set. Hotels are ordered by total price, so if more than the given maximum number of hotels are available, only the cheapest options are returned.","in":"query","name":"number_of_results","requi