Amadeus provides a rich set of APIs for the travel industry. For more details, check out the Amadeus for Developers Portal or the SDK class reference.
This module has been tested using Node LTS versions. You can install it using Yarn or NPM.
npm install amadeus --saveTo make your first API call, you will need to register for an Amadeus Developer Account and set up your first application.
constAmadeus=require('amadeus');constamadeus=newAmadeus({clientId: 'REPLACE_BY_YOUR_API_KEY',clientSecret: 'REPLACE_BY_YOUR_API_SECRET'});amadeus.shopping.flightOffersSearch.get({originLocationCode: 'SYD',destinationLocationCode: 'BKK',departureDate: '2022-06-01',adults: '2'}).then(function(response){console.log(response.data);}).catch(function(responseError){console.log(responseError.code);});You can find all the endpoints in self-contained code examples.
The client can be initialized directly.
// Initialize using parametersconstamadeus=newAmadeus({clientId: 'REPLACE_BY_YOUR_API_KEY',clientSecret: 'REPLACE_BY_YOUR_API_SECRET'});Alternatively, it can be initialized without any parameters if the environment variables AMADEUS_CLIENT_ID and AMADEUS_CLIENT_SECRET are present.
constamadeus=newAmadeus();Your credentials can be found on the Amadeus dashboard.
By default, the SDK environment is set to test environment. To switch to a production (pay-as-you-go) environment, please switch the hostname as follows:
constamadeus=newAmadeus({hostname: 'production'});Amadeus has a large set of APIs, and our documentation is here to get you started today. Head over to our reference documentation for in-depth information about every SDK method, its arguments and return types.
This library conveniently maps every API path to a similar path. For example, GET /v2/reference-data/urls/checkin-links?airlineCode=BA would be:
amadeus.referenceData.urls.checkinLinks.get({airlineCode: 'BA'});Similarly, to select a resource by ID, you can pass in the ID to the singular path. For example, GET /v1/shopping/hotelOffers/123/ would be:
amadeus.shopping.hotelOffer('123').get(...);You can make any arbitrary GET API call directly with the .client.get method as well:
amadeus.client.get('/v2/reference-data/urls/checkin-links',{airlineCode: 'BA'});Or, with a POST using .client.post method:
amadeus.client.post('/v1/shopping/flight-offers/pricing',{ data });Every API call returns a Promise that either resolves or rejects.
Every resolved API call returns a Response object containing a body attribute with the raw response. If the API call contained a JSON response, it will parse the JSON into the result attribute. If this data contains a data key, that will be made available in data attribute.
For a failed API call, it returns a ResponseErrorobject containing the (parsed or unparsed) response, the request, and an error code.
amadeus.referenceData.urls.checkinLinks.get({airlineCode: 'BA'}).then(function(response){console.log(response.body);//=> The raw bodyconsole.log(response.result);//=> The fully parsed resultconsole.log(response.data);//=> The data attribute taken from the result}).catch(function(error){console.log(error.response);//=> The response object with (un)parsed dataconsole.log(error.response.request);//=> The details of the request madeconsole.log(error.code);//=> A unique error code to identify the type of error});If an API endpoint supports pagination, the other pages are available under the .next, .previous, .last and .first methods.
amadeus.referenceData.locations.get({keyword: 'LON',subType: 'AIRPORT,CITY'}).then(function(response){console.log(response.data);// first pagereturnamadeus.next(response);}).then(function(nextResponse){console.log(nextResponse.data);// second page});If a page is not available, the response will resolve to null.
The SDK makes it easy to add your own logger that is compatible with the default console.
constamadeus=newAmadeus({clientId: 'REPLACE_BY_YOUR_API_KEY',clientSecret: 'REPLACE_BY_YOUR_API_SECRET',logger: newMyConsole()});Additionally, to enable more verbose logging, you can set the appropriate level on your own logger. The easiest way would be to enable debugging via a parameter during initialization, or using the AMADEUS_LOG_LEVEL environment variable. The available options are silent (default), warn, and debug.
constamadeus=newAmadeus({clientId: 'REPLACE_BY_YOUR_API_KEY',clientSecret: 'REPLACE_BY_YOUR_API_SECRET',logLevel: 'debug'});//Airport Routes amadeus.airport.directDestinations.get({departureAirportCode: 'CDG',})//Airline Routes//find all destinations served by a given airlineamadeus.airline.destinations.get({airlineCode: 'BA',})// Flight Inspiration Searchamadeus.shopping.flightDestinations.get({origin : 'MAD'})// Flight Cheapest Date Searchamadeus.shopping.flightDates.get({origin : 'MAD',destination : 'MUC'})// Flight Offers Search GETamadeus.shopping.flightOffersSearch.get({originLocationCode: 'SYD',destinationLocationCode: 'BKK',departureDate: '2022-11-01',adults: '2'})// Flight Offers Search POST// A full example can be found at https://github.com/amadeus4dev/amadeus-code-examplesamadeus.shopping.flightOffersSearch.post(body)// Flight Offers Priceamadeus.shopping.flightOffersSearch.get({originLocationCode: 'SYD',destinationLocationCode: 'BKK',departureDate: '2022-11-01',adults: '1'}).then(function(response){returnamadeus.shopping.flightOffers.pricing.post({'data': {'type': 'flight-offers-pricing','flightOffers': [response.data[0]]}})}).then(function(response){console.log(response.data);}).catch(function(responseError){console.log(responseError);});// Flight Offers Price with additional parameters// for example: check additional baggage options amadeus.shopping.flightOffers.pricing.post(body,{include: 'bags'});// Flight Create Orders// To book the flight-offer(s) returned by the Flight Offers Price// and create a flight-order with travelers' information.// A full example can be found at https://git.io/JtnYoamadeus.booking.flightOrders.post({'type': 'flight-order','flightOffers': [priced-offers],'travelers': []});// Retrieve flight order with ID 'XXX'. This ID comes from the// Flight Create Orders API, which is a temporary ID in test environment.amadeus.booking.flightOrder('XXX').get()// Cancel flight order with ID 'XXX'. This ID comes from the// Flight Create Orders API, which is a temporary ID in test environment.amadeus.booking.flightOrder('XXX').delete()// Flight SeatMap Display// To retrieve the seat map of each flight included// in flight offers for MAD-NYC flight on 2021-08-01amadeus.shopping.flightOffersSearch.get({originLocationCode: 'SYD',destinationLocationCode: 'BKK',departureDate: '2022-11-01',adults: '1'}).then(function(response){returnamadeus.shopping.seatmaps.post({'data': [response.data[0]]});}).then(function(response){console.log(response.data);}).catch(function(responseError){console.log(responseError);});// To retrieve the seat map for flight order with ID 'XXX'amadeus.shopping.seatmaps.get({'flight-orderId': 'XXX'});// Flight Availabilities Searchamadeus.shopping.availability.flightAvailabilities.post(body);// Branded Fares Upsell amadeus.shopping.flightOffers.upselling.post(body);// Flight Choice Predictionamadeus.shopping.flightOffersSearch.get({originLocationCode: 'SYD',destinationLocationCode: 'BKK',departureDate: '2022-11-01',adults: '2'}).then(function(response){returnamadeus.shopping.flightOffers.prediction.post(response);}).then(function(response){console.log(response.data);}).catch(function(responseError){console.log(responseError);});// Flight Checkin Linksamadeus.referenceData.urls.checkinLinks.get({airlineCode : 'BA'})// Airline Code Lookupamadeus.referenceData.airlines.get({airlineCodes : 'U2'})// Airports and City Search (autocomplete)// Find all the cities and airports starting by 'LON'amadeus.referenceData.locations.get({keyword : 'LON',subType : Amadeus.location.any})// Get a specific city or airport based on its idamadeus.referenceData.location('ALHR').get()// Airport Nearest Relevant Airport (for London)amadeus.referenceData.locations.airports.get({longitude : 0.1278,latitude : 51.5074})// Flight Most Booked Destinationsamadeus.travel.analytics.airTraffic.booked.get({originCityCode : 'MAD',period : '2017-08'}// Flight Most Traveled Destinationsamadeus.travel.analytics.airTraffic.traveled.get({originCityCode : 'MAD',period : '2017-01'})// Flight Busiest Traveling Periodamadeus.travel.analytics.airTraffic.busiestPeriod.get({cityCode: 'MAD',period: '2017',direction: Amadeus.direction.arriving})// City Search API// finds cities that match a specific word or string of letters. // Return a list of cities matching a keyword 'Paris'amadeus.referenceData.locations.cities.get({keyword: 'Paris'})//Hotel Name Autocomplete API//Autocomplete a hotel search fieldamadeus.referenceData.locations.hotel.get({keyword: 'PARI',subType: 'HOTEL_GDS'})//Hotel List API //Get list of hotels by city codeamadeus.referenceData.locations.hotels.byCity.get({cityCode: 'PAR'})//Get List of hotels by Geocodeamadeus.referenceData.locations.hotels.byGeocode.get({latitude: 48.83152,longitude: 2.24691})//Get List of hotels by hotelIdsamadeus.referenceData.locations.hotels.byHotels.get({hotelIds: 'ACPAR245'})// Hotel Search API V3// Get list of available offers in specific hotels by hotel idsamadeus.shopping.hotelOffersSearch.get({hotelIds: 'RTPAR001',adults: '2'})// Check offer conditions of a specific offer idamadeus.shopping.hotelOfferSearch('XXX').get()// Hotel Booking API v2amadeus.booking.hotelOrders.post({'data': {'type': 'hotel-order','guests': [],'travelAgent': {},'roomAssociations': [],'payment': {}}})// Hotel Booking API v1amadeus.booking.hotelBookings.post({'data': {'offerId': 'XXXX','guests': [],'payments': [],'rooms': []}})// On-Demand Flight Status// What's the current status of my flight?amadeus.schedule.flights.get({carrierCode: 'AZ',flightNumber: '319',scheduledDepartureDate: '2021-03-13'})// Points of Interest// What are the popular places in Barcelona (based a geo location and a radius)amadeus.referenceData.locations.pointsOfInterest.get({latitude : 41.397158,longitude : 2.160873})// What are the popular places in Barcelona? (based on a square)amadeus.referenceData.locations.pointsOfInterest.bySquare.get({north: 41.397158,west: 2.160873,south: 41.394582,east: 2.177181})// Extract the information about point of interest with ID '9CB40CB5D0'amadeus.referenceData.locations.pointOfInterest('9CB40CB5D0').get()// Location Scoreamadeus.location.analytics.categoryRatedAreas.get({latitude : 41.397158,longitude : 2.160873})// Tours and Activities// What are the best tours and activities in Barcelona?amadeus.shopping.activities.get({latitude: 41.397158,longitude: 2.160873})// What are the best tours and activities in Barcelona? (based on a Square)amadeus.shopping.activities.bySquare.get({north: 41.397158,west: 2.160873,south: 41.394582,east: 2.177181})// Extract the information about an activity with ID '56777'amadeus.shopping.activity('56777').get()// Hotel Ratings// Get Sentiment Analysis of reviews about Holiday Inn Paris Notre Dame.amadeus.eReputation.hotelSentiments.get({hotelIds: 'XKPARC12'})// Trip Purpose Prediction// Forecast traveler purpose, Business or Leisure, together with the probability in the context of search & shopping.amadeus.travel.predictions.tripPurpose.get({originLocationCode: 'NYC',destinationLocationCode: 'MAD',departureDate: '2021-04-01',returnDate: '2021-04-08'})// Flight Delay Prediction// This machine learning API is based on a prediction model that takes the input of the user - time, carrier, airport and aircraft information;// and predict the segment where the flight is likely to lay.amadeus.travel.predictions.flightDelay.get({originLocationCode: 'BRU',destinationLocationCode: 'FRA',departureDate: '2020-01-14',departureTime: '11:05:00',arrivalDate: '2020-01-14',arrivalTime: '12:10:00',aircraftCode: '32A',carrierCode: 'LH',flightNumber: '1009',duration: 'PT1H05M'})// Airport On-time Performance// Get the percentage of on-time flight departures from JFKamadeus.airport.predictions.onTime.get({airportCode: 'JFK',date: '2022-18-01'})// Travel Recommendationsamadeus.referenceData.recommendedLocations.get({cityCodes: 'PAR',travelerCountryCode: 'FR'})// Flight Price Analysisamadeus.analytics.itineraryPriceMetrics.get({originIataCode: 'MAD',destinationIataCode: 'CDG',departureDate: '2022-03-13',})//Cars & Transfers APIs// Transfer Search API: Search Transferamadeus.shopping.transferOffers.post(body);// Transfer Book API: Book a transfer based on the offer idamadeus.ordering.transferOrders.post(body,offerId='2094123123');// Transfer Management API: Cancel a transfer based on the order id & confirmation numberamadeus.ordering.transferOrder('XXX').transfers.cancellation.post({},confirmNbr='12345');Want to contribute? Read our Contributors Guide for guidance on installing and running this code in a development environment.
This library is released under the MIT License.
You can find us on StackOverflow or join our developer community on Discord.