Amadeus Node SDK
Amadeus provides a set of APIs for the travel industry. Flights, Hotels, Locations and more.
For more details see the Node
documentation on
Amadeus.com.
Installation
This module has been tested using Node 6 and higher, though it should work with
Node 4 and 5 as well. You can install install it using Yarn or NPM.
npm install amadeus --save
Getting Started
To make your first API call you will need to register for an Amadeus Developer
Account and set up your first
application.
var Amadeus = require('amadeus');
var amadeus = new Amadeus({
clientId: 'REPLACE_BY_YOUR_API_KEY',
clientSecret: 'REPLACE_BY_YOUR_API_SECRET'
});
amadeus.referenceData.urls.checkinLinks.get({
airlineCode: 'BA'
}).then(function(response){
console.log(response.data[0].href);
}).catch(function(responseError){
console.log(responseError.code);
});
Initialization
The client can be initialized directly.
// Initialize using parameters
var amadeus = new Amadeus({
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.
var amadeus = new Amadeus();
Your credentials can be found on the Amadeus
dashboard. Sign
up for an account today.
By default the environment for the SDK is the test environment. To switch to
a production (paid-for) environment please switch the hostname as follows:
var amadeus = new Amadeus({
hostname: 'production'
});
Documentation
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, it's arguments and return types.
Making API calls
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/hotelOffer/123/ would be:
amadeus.shopping.hotelOffer('123').get(...);
You can make any arbitrary API call as well directly with the .client.get method:
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', JSON.stringify({ data }));
Promises
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 also contains a data key,
it will make that available as the .data attribute.
For a failed API call it returns a ResponseError
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 body
console.log(response.result); //=> The fully parsed result
console.log(response.data); //=> The data attribute taken from the result
}).catch(function(error){
console.log(error.response); //=> The response object with (un)parsed data
console.log(error.response.request); //=> The details of the request made
console.log(error.code); //=> A unique error code to identify the type of error
});
Pagination
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 page
return amadeus.next(response);
}).then(function(nextResponse){
console.log(nextResponse.data); // second page
});
If a page is not available, the response will resolve to null.
Logging & Debugging
The SDK makes it easy to add your own logger compatible with the default console.
var amadeus = new Amadeus({
clientId: 'REPLACE_BY_YOUR_API_KEY',
clientSecret: 'REPLACE_BY_YOUR_API_SECRET',
logger: new MyConsole()
});
Additionally, to enable more verbose logging, you can set the appropriate level
on your own logger, though the easiest way would be to enable debugging via a
parameter on initialization, or using the AMADEUS_LOG_LEVEL environment
variable. The available options are silent (default), warn, and debug.
var amadeus = new Amadeus({
clientId: 'REPLACE_BY_YOUR_API_KEY',
clientSecret: 'REPLACE_BY_YOUR_API_SECRET',
logLevel: 'debug'
});
List of supported endpoints
// Flight Inspiration Search
amadeus.shopping.flightDestinations.get({
origin : 'MAD'
})
// Flight Cheapest Date Search
amadeus.shopping.flightDates.get({
origin : 'MAD',
destination : 'MUC'
})
// Flight Low-fare Search
amadeus.shopping.flightOffers.get({
origin : 'NYC',
destination : 'MAD',
departureDate : '2020-08-01'
})
// Flight Offers Search
amadeus.shopping.flightOffersSearch.get({
originLocationCode: 'SYD',
destinationLocationCode: 'BKK',
departureDate: '2020-08-01',
adults: '2'
})
// Flight Choice Prediction
amadeus.shopping.flightOffers.get({
origin: 'MAD',
destination: 'NYC',
departureDate: '2020-08-01'
}).then(function(response){
return amadeus.shopping.flightOffers.prediction.post(
JSON.stringify(response.result)
);
}).then(function(response){
console.log(response.data);
}).catch(function(responseError){
console.log(responseError);
});
// Flight Checkin Links
amadeus.referenceData.urls.checkinLinks.get({
airlineCode : 'BA'
})
// Airline Code Lookup
amadeus.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 id
amadeus.referenceData.location('ALHR').get()
// Airport Nearest Relevant Airport (for London)
amadeus.referenceData.locations.airports.get({
longitude : 0.1278,
latitude : 51.5074
})
// Flight Most Searched Destinations
// Which were the most searched flight destinations from Madrid in August 2017?
amadeus.travel.analytics.airTraffic.searched.get({
originCityCode : 'MAD',
searchPeriod : '2017-08',
marketCountryCode : 'ES'
})
// How many people in Spain searched for a trip from Madrid to New-York in September 2017?
amadeus.travel.analytics.airTraffic.searchedByDestination.get({
originCityCode : 'MAD',
destinationCityCode : 'NYC',
searchPeriod : '2017-08',
marketCountryCode : 'ES'
})
// Flight Most Booked Destinations
amadeus.travel.analytics.airTraffic.booked.get({
originCityCode : 'MAD',
period : '2017-08'
})
// Flight Most Traveled Destinations
amadeus.travel.analytics.airTraffic.traveled.get({
originCityCode : 'MAD',
period : '2017-01'
})
// Flight Busiest Traveling Period
amadeus.travel.analytics.airTraffic.busiestPeriod.get({
cityCode: 'MAD',
period: '2017',
direction: Amadeus.direction.arriving
})
// Hotel Search API
// Get list of hotels by city code
amadeus.shopping.hotelOffers.get({
cityCode : 'MAD'
})
// Get list of offers for a specific hotel
amadeus.shopping.hotelOffersByHotel.get({
hotelId : 'XKPARC12'
})
// Confirm the availability of a specific offer id
amadeus.shopping.hotelOffer('XXX').get()
// 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
})
// 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: '2020-08-01',
returnDate: '2020-08-12'
})
// AI-Generated Photos
// Get a link to download a rendered image of a landscape.
amadeus.media.files.generatedPhotos.get({
category: 'BEACH'
})
// 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 JFK
amadeus.airport.predictions.onTime.get({
airportCode: 'JFK',
date: '2020-08-01'
})
Development & Contributing
Want to contribute? Read our Contributors Guide for
guidance on installing and running this code in a development environment.
License
This library is released under the MIT License.
Help
Our developer support team is here to
help you. You can find us on
StackOverflow and
email.