11.0.0The Amadeus client library for accessing the travel APIs.
Initialize using your credentials:
Alternatively, initialize the library using
the environment variables AMADEUS_CLIENT_ID
and AMADEUS_CLIENT_SECRET
(Object
= {})
| Name | Description |
|---|---|
params.clientId string
|
the API key used to authenticate the API |
params.clientSecret string
|
the API secret used to authenticate the API |
params.logger Object
(default console)
|
a
console
-compatible logger that
accepts
log
,
error
and
debug
calls.
|
params.logLevel string
(default 'warn')
|
the log level for the client,
available options are
debug
,
warn
, and
silent
|
params.hostname string
(default 'production')
|
the name of the server API
calls are made to (
production
or
test
)
|
params.host string?
|
the full domain or IP for a server to make the API clal to. Only use this if you don't want to use the provided servers |
params.ssl boolean
(default true)
|
wether to use SSL for this API call |
params.port number
(default 443)
|
the port to make the API call to |
params.customAppId string
(default null)
|
a custom App ID to be passed in the User Agent to the server. |
params.customAppVersion string
(default null)
|
a custom App Version number to be passed in the User Agent to the server. |
params.http Object
(default https)
|
an optional Node/HTTP(S)-compatible client that accepts a 'request()' call with an array of options. |
(Client)
: The client for making authenticated HTTP calls
(number)
: The version of this API client
A handy list of location types, to be used in the locations API:
Currently available are the types .airport, .city, and .any
A handy list of direction types, to be used in the Flight Busiest Period API:
Currently available are the types .arriving and .departing
The previous page for the given response. Resolves to null if the page could not be found.
(any)
the previous response for an API call
Promise<Response, ResponseError>:
a Promise
The next page for the given response. Resolves to null if the page could not be found.
(any)
the previous response for an API call
Promise<Response, ResponseError>:
a Promise
The first page for the given response. Resolves to null if the page could not be found.
(any)
the previous response for an API call
Promise<Response, ResponseError>:
a Promise
The last page for the given response. Resolves to null if the page could not be found.
(any)
the previous response for an API call
Promise<Response, ResponseError>:
a Promise
A convenient wrapper around the API, allowing for generic, authenticated and unauthenticated API calls without having to manage the serialization, desrialization, and authentication.
Generally you do not need to use this object directly. Instead it is used indirectly by the various namespaced methods for every API call.
For example, the following are the semantically the same.
(string)
: the API key used to authenticate the API
(string)
: the API secret used to authenticate
the API
(string)
: the log level for the client, available options
are
debug
,
warn
, and
silent
. Defaults to 'silent'
(string)
: the hostname of the server API calls are made to
(number)
: the port the server API calls are made to
(boolean)
: wether an SSL request is made to the server
(string)
: the custom App ID to be passed in the User
Agent to the server
(string)
: the custom App Version number to be
passed in the User Agent to the server
(Object)
: the Node/HTTP(S)-compatible client used to make
requests
(number)
: The version of this API client
Make an authenticated GET API call.
Promise<Response, ResponseError>:
a Promise
Make an authenticated POST API call.
Promise<Response, ResponseError>:
a Promise
Make an authenticated DELETE API call.
Promise<Response, ResponseError>:
a Promise
The error that is passed to the Promise when the API call fails.
A Request object containing all the compiled information about this request.
(Object)
(string)
: the host used for this API call
(number)
: the port for this API call. Standard set to 443.
(boolean)
: wether this API call uses SSL
(string)
: the scheme inferred from the SSL state
(string)
: the full path of the API endpoint
(Object)
: the parameters to pass in the query or body
(string)
: the path and query string used for the API call
(string)
: the authentication token
(string)
: the version of the Amadeus library
(string)
: the version of Node used
(string)
: the custom ID of the application using this library
(string)
: the custom version of the application
using this library
(Object)
: the request headers
The response object returned for every API call.
(Object)
the response object returned from the Node/HTTP
request
(Request)
the request object used to make this API call
(number)
: the HTTP status code for the response, if any
(string)
: the raw body received from the API
(Object)
: the parsed JSON received from the API
(Object)
: the data attribute taken from the result
(boolean)
: wether the raw body has been parsed into JSON
(Request)
: the request object used to make this API call
A namespaced client for the
/v1/airline endpoints
Access via the Amadeus object
(Client)
(predictions)
A namespaced client for the
/v1/airline/destinations endpoints
Access via the Amadeus object
(Client)
find all destinations served by a given airline
Promise<Response, ResponseError>:
a Promise
What destinations are served by this airline?
A namespaced client for the
/v1/airport endpoints
Access via the Amadeus object
(Client)
(predictions)
A namespaced client for the
/v1/airport/direct-destinations endpoints
Access via the Amadeus object
(Client)
Get the percentage of on-time flight departures from a given airport
Promise<Response, ResponseError>:
a Promise
What destinations are served by this airport?
A namespaced client for the
/v1/airport/predictions endpoints
Access via the Amadeus object
(Client)
(predictions)
A namespaced client for the
/v1/travel/predictions/trip-purpose endpoints
Access via the Amadeus object
(Client)
(TripPurpose)
(FlightDelay)
A namespaced client for the
/v1/airport/predictions/on-time endpoints
Access via the Amadeus object
(Client)
Get the percentage of on-time flight departures from a given airport
Promise<Response, ResponseError>:
a Promise
Get the percentage of on-time flight departures from JFK
A namespaced client for the
/v1/location/analytics endpoints
Access via the Amadeus object
(Client)
(analytics)
A namespaced client for the `/v1/analytics/itinerary-price-metrics
Access via the Amadeus object
(Client)
Provides historical prices in a quartile distribution, including minimum, maximum and average price.
(Object
= {})
| Name | Description |
|---|---|
params.originIataCode string
|
city/airport code, following IATA standard, from which the traveler will depart |
params.destinationIataCode string
|
city/airport code, following IATA standard, from which the traveler is going |
params.departureDate string
|
The date on which the traveler will depart from the origin to go to the destination. |
Promise<Response, ResponseError>:
a Promise
Am I getting a good deal on this flight?
A namespaced client for the
/v1/booking/flight-orders endpoints
Access via the Amadeus object
(Client)
(any)
To retrieve a flight order based on its id.
Promise<Response, ResponseError>:
a Promise
To retrieve a flight order with ID 'XXX'
To cancel a flight order based on its id.
Promise<Response, ResponseError>:
a Promise
To cancel a flight order with ID 'XXX'
A namespaced client for the
/v1/booking/flight-orders endpoints
Access via the Amadeus object
(Client)
To book the selected flight-offer and create a flight-order
(Object
= {})
Promise<Response, ResponseError>:
a Promise
To book the flight-offer(s) suggested by flightOffersSearch and create a flight-order
A namespaced client for the
/v1/booking/hotel-bookings endpoints
Access via the Amadeus object
(Client)
To book the offer retrieved from Hotel Shopping API.
(Object
= {})
Promise<Response, ResponseError>:
a Promise
To book the hotel offer with ID 'XXX' with guests & payments info
A namespaced client for the
/v2/booking/hotel-orders endpoints
Access via the Amadeus object
(Client)
To book the offer retrieved from Hotel Search API.
(Object
= {})
Promise<Response, ResponseError>:
a Promise
To book the hotel offer with ID 'XXX' with guests, travel agents and payment info
A namespaced client for the
/v2/e-reputation endpoints
Access via the Amadeus object
(Client)
(hotelSentiments)
A namespaced client for the
/v2/e-reputation/hotel-sentiments endpoints
Access via the Amadeus object
(Client)
Get the sentiment analysis of hotel reviews
Promise<Response, ResponseError>:
a Promise
Get Sentiment Analysis of reviews about Holiday Inn Paris Notre Dame.
A namespaced client for the
/v1/location endpoints
Access via the Amadeus object
(Client)
(analytics)
Returns details for a specific airport
(Object
= {})
Promise<Response, ResponseError>:
a Promise
Find details for location with ID 'ALHR'
A namespaced client for the
/v2/reference-data/locations/:location_id endpoints
Access via the Amadeus object
(Client)
(any)
(number)
Returns details for a specific airport
(Object
= {})
Promise<Response, ResponseError>:
a Promise
Find details for location with ID 'ALHR'
A namespaced client for the
/v1/location/analytics/category-rated-areas endpoints
Access via the Amadeus object
(Client)
Gets popularity score for location categories
(Object
= {})
| Name | Description |
|---|---|
params.latitude Double
|
latitude location to be at the center of the search circle - required |
params.longitude Double
|
longitude location to be at the center of the search circle - required |
params.radius Double
|
radius of the search in Kilometer - optional |
Promise<Response, ResponseError>:
a Promise
Gets popularity score for location categories in Barcelona
A namespaced client for the
/v2/media endpoints
Access via the Amadeus object
(Client)
(Files)
A namespaced client for the
/v2/media/files endpoints
Access via the Amadeus object
(Client)
A namespaced client for the
/v1/ordering endpoints
Access via the Amadeus object
(Client)
(TransferOrders)
(TransferOrder)
A namespaced client for the
/v1/ordering/transfer-orders/XXXXX endpoints
Access via the Amadeus object
A namespaced client for the
/v1/ordering/transfer-orders endpoints
Access via the Amadeus object
(Client)
To book the selected transfer-offer and create a transfer-order
(any)
(any)
Promise<Response, ResponseError>:
a Promise
To book the transfer-offer(s) suggested by transferOffers and create a transfer-order
A namespaced client for the
/v1/ordering/transfer-orders/XXXXX/transfers endpoints
Access via the Amadeus object
(Client)
(any)
A namespaced client for the
/v1/ordering/transfer-orders/XXX/transfers/cancellation endpoints
Access via the Amadeus object
(Client)
(any)
To cancel a transfer order based on its id
(any)
(any)
Promise<Response, ResponseError>:
a Promise
To cancel a transfer order with ID 'XXX' and confirmation number '12345'
A namespaced client for the
/v1/reference-data/airlines endpoints
Access via the Amadeus object
(Client)
Returns the airline name and code.
Promise<Response, ResponseError>:
a Promise
Find to which airlines belongs IATA Code BA
A namespaced client for the
/v2/reference-data/locations endpoints
Access via the Amadeus object
(Client)
(Airports)
Returns a list of airports and cities matching a given keyword.
Promise<Response, ResponseError>:
a Promise
Find any location starting with 'lon'
A namespaced client for the
/v2/reference-data/locations/airports endpoints
Access via the Amadeus object
(Client)
Returns a list of relevant airports near to a given point.
(Object
= {})
| Name | Description |
|---|---|
params.latitude Double
|
latitude location to be at the center of the search circle - required |
params.longitude Double
|
longitude location to be at the center of the search circle - required |
Promise<Response, ResponseError>:
a Promise
Find the nearest airport to the 49.0000,2.55 lat/long
A namespaced client for the
/v2/reference-data/locations/cities endpoints
Access via the Amadeus object
(Client)
Return a list of cities matching a given keyword..
Promise<Response, ResponseError>:
a Promise
Return a list of cities matching a keyword 'France'
A namespaced client for the
/v1/reference-data/locations/hotel endpoints
Access via the Amadeus object
(Client)
Returns a list of hotels for a given area.
Promise<Response, ResponseError>:
a Promise
Find relevant points of interest within an area in Barcelona
A namespaced client for the
/v1/reference-data/locations/hotels endpoints
Access via the Amadeus object
(Client)
A namespaced client for the
/v1/reference-data/locations/hotels/by-city endpoints
Access via the Amadeus object
(Client)
Returns a list of hotels for a given area.
Promise<Response, ResponseError>:
a Promise
Find list of hotels in Barcelona
A namespaced client for the
/v1/reference-data/locations/hotels/by-geocode endpoints
Access via the Amadeus object
(Client)
Returns a list of hotels for a given area.
(Object
= {})
| Name | Description |
|---|---|
params.latitude Double
|
latitude location to be at the center of the search circle - required |
params.longitude Double
|
longitude location to be at the center of the search circle - required |
Promise<Response, ResponseError>:
a Promise
Returns a list of hotels within an area in Barcelona
A namespaced client for the
/v1/reference-data/locations/hotels/by-hotels endpoints
Access via the Amadeus object
(Client)
Returns a list of hotels for a given area.
Promise<Response, ResponseError>:
a Promise
Find relevant points of interest within an area in Barcelona
A namespaced client for the
/v1/reference-data/locations/pois endpoints
Access via the Amadeus object
(Client)
(any)
Extracts the information about point of interest with given ID
Extract the information about point of interest with ID '9CB40CB5D0'
A namespaced client for the
/v1/reference-data/locations/pois/by-square endpoints
Access via the Amadeus object
(Client)
Returns a list of relevant points of interest for a given area.
(Object
= {})
| Name | Description |
|---|---|
params.north Double
|
latitude north of bounding box - required |
params.west Double
|
longitude west of bounding box - required |
params.south Double
|
latitude south of bounding box - required |
params.east Double
|
longitude east of bounding box - required |
Promise<Response, ResponseError>:
a Promise
Find relevant points of interest within an area in Barcelona
Returns a list of tours and activities a given area.
(Object
= {})
| Name | Description |
|---|---|
params.north Double
|
latitude north of bounding box - required |
params.west Double
|
longitude west of bounding box - required |
params.south Double
|
latitude south of bounding box - required |
params.east Double
|
longitude east of bounding box - required |
Promise<Response, ResponseError>:
a Promise
Find relevant tours and activities within an area in Barcelona
A namespaced client for the
/v1/shopping/activities/by-square endpoints
Access via the Amadeus object
(Client)
Returns a list of relevant points of interest for a given area.
(Object
= {})
| Name | Description |
|---|---|
params.north Double
|
latitude north of bounding box - required |
params.west Double
|
longitude west of bounding box - required |
params.south Double
|
latitude south of bounding box - required |
params.east Double
|
longitude east of bounding box - required |
Promise<Response, ResponseError>:
a Promise
Find relevant points of interest within an area in Barcelona
Returns a list of tours and activities a given area.
(Object
= {})
| Name | Description |
|---|---|
params.north Double
|
latitude north of bounding box - required |
params.west Double
|
longitude west of bounding box - required |
params.south Double
|
latitude south of bounding box - required |
params.east Double
|
longitude east of bounding box - required |
Promise<Response, ResponseError>:
a Promise
Find relevant tours and activities within an area in Barcelona
A namespaced client for the
/v1/reference-data/locations/pois endpoints
Access via the Amadeus object
(Client)
Returns a list of relevant points of interest near to a given point
(Object
= {})
| Name | Description |
|---|---|
params.latitude Double
|
latitude location to be at the center of the search circle - required |
params.longitude Double
|
longitude location to be at the center of the search circle - required |
params.radius Double
|
radius of the search in Kilometer - optional |
Promise<Response, ResponseError>:
a Promise
Find relevant points of interest close to Barcelona
A namespaced client for the
/v1/reference-data/recommended-locations endpoints
Access via the Amadeus object
(Client)
Returns the recommended locations (destinations).
Promise<Response, ResponseError>:
a Promise
Get recommended destinations from a given origin
A namespaced client for the
/v2/reference-data/urls/checkin-links endpoints
Access via the Amadeus object
(Client)
Returns the checkin links for an airline, for the language of your choice
Promise<Response, ResponseError>:
a Promise
Find a the checkin links for Air France
A namespaced client for the
/v2/schedule/flights endpoints
Access via the Amadeus object
(Client)
Provides real-time flight schedule data including up-to-date departure and arrival times, terminal and gate information, flight duration and real-time delay status
(Object
= {})
| Name | Description |
|---|---|
params.carrierCode Double
|
2 to 3-character IATA carrier code - required |
params.flightNumber Double
|
1 to 4-digit number of the flight. e.g. 4537 - required |
params.scheduledDepartureDate Double
|
scheduled departure date of the flight, local to the departure airport - required |
Promise<Response, ResponseError>:
a Promise
What's the current status of my flight?
A namespaced client for the
/v1/shopping, /v2/shopping and /v3/shopping endpoints
Access via the Amadeus object
(Client)
(FlightDestinations)
(FlightOffers)
(FlightOffersSearch)
(FlightDates)
(Seatmaps)
(HotelOfferSearch)
(HotelOffersSearch)
(Availability)
(TransferOffers)
Loads a namespaced path for a specific offer ID for Hotel Search V3
(string?)
The ID of the offer for a dedicated hotel
HotelOfferSearch:
A namespaced client for the
/v1/shopping/activities endpoints
Access via the Amadeus object
(Client)
/shopping/activities
(Object
= {})
| Name | Description |
|---|---|
params.latitude Double
|
latitude location to be at the center of the search circle - required |
params.longitude Double
|
longitude location to be at the center of the search circle - required |
params.radius Double
|
radius of the search in Kilometer - optional |
Promise<Response, ResponseError>:
a Promise
What are the best tours and activities in Barcelona? (based a geo location and a radius)
A namespaced client for the
/v1/shopping/activities/{activityId} endpoints
Access via the Amadeus object
(Client)
(any)
Retieve information of an activity by its Id.
What is the activity information with Id 3216547684?
A namespaced client for the
/v1/shopping/availability/flight-availabilities endpoints
Access via the Amadeus object
(Client)
Get available seats in different fare classes
(Object
= {})
Promise<Response, ResponseError>:
a Promise
A namespaced client for the
/v1/shopping/flight-dates endpoints
Access via the Amadeus object
(Client)
Find the cheapest flight dates from an origin to a destination.
Promise<Response, ResponseError>:
a Promise
Find the cheapest flight dates from New-York to Madrid
A namespaced client for the
/v1/shopping/flight-destinations endpoints
Access via the Amadeus object
(Client)
Find the cheapest destinations where you can fly to.
Promise<Response, ResponseError>:
a Promise
Find the cheapest destination from Madrid
A namespaced client for the
/v2/shopping/flight-offers endpoints
Access via the Amadeus object
(Client)
Get cheapest flight recommendations and prices on a given journey.
(Object
= {})
| Name | Description |
|---|---|
params.originLocationCode string
|
city/airport IATA code from which the traveler will depart, e.g. BOS for Boston |
params.destinationLocationCode string
|
city/airport IATA code to which the traveler is going, e.g. PAR for Paris |
params.departureDate string
|
the date on which the traveler will depart from the origin to go to the destination. Dates are specified in the ISO 8601 YYYY-MM-DD format, e.g. 2017-12-25 |
params.adults string
|
the number of adult travelers (age 12 or older on date of departure) |
Promise<Response, ResponseError>:
a Promise
Get cheapest flight recommendations and prices for SYD-BKK on 2020-08-01 for 2 adults
To do a customized search with every option available.
(Object
= {})
| Name | Description |
|---|---|
params.getFlightOffersBody Double
|
list of criteria to retrieve a list of flight offers |
Promise<Response, ResponseError>:
a Promise
To do a customized search with given options.
A namespaced client for the
/v1/shopping/flight-offers endpoints
Access via the Amadeus object
(Client)
A namespaced client for the
/v1/shopping/flight-offers/prediction endpoints
Access via the Amadeus object
(Client)
Returns a list of flight offers with the probability to be chosen.
(Object
= {})
Promise<Response, ResponseError>:
a Promise
Returns flights from NYC to MAD with the probability to be chosen.
A namespaced client for the
/v1/shopping/flight-offers/pricing endpoints
Access via the Amadeus object
(Client)
To get or confirm the price of a flight and obtain information about taxes and fees to be applied to the entire journey. It also retrieves ancillary information (e.g. additional bag or extra legroom seats pricing) and the payment information details requested at booking time.
(Object
= {})
| Name | Description |
|---|---|
params.data Object
|
|
params.data.type string
|
'flight-offers-pricing' for Flight Offer Pricing |
params.data.flightOffers Array
|
list of flight offers for which the pricing needs to be retrieved |
(any
= {})
Promise<Response, ResponseError>:
a Promise
A namespaced client for the
/v1/shopping/flight-offers/upselling endpoints
Access via the Amadeus object
(Client)
Get available seats in different fare classes
(Object
= {})
Promise<Response, ResponseError>:
a Promise
A namespaced client for the
/v3/shopping/hotel-offers/:offer_id endpoints
Access via the Amadeus object
(Client)
(any)
(number)
Returns details for a specific offer
(Object
= {})
Promise<Response, ResponseError>:
a Promise
Find details for the offer with ID 'XXX'
A namespaced client for the
/v3/shopping/hotel-offers endpoints
Access via the Amadeus object
(Client)
Find the list of available offers in the specific hotels
Promise<Response, ResponseError>:
a Promise
Search for available offers in Novotel Paris for 2 adults
A namespaced client for the
/v1/shopping/seatmaps endpoints
Access via the Amadeus object
(Client)
To retrieve the seat map of each flight present in an order.
(Object
= {})
Promise<Response, ResponseError>:
a Promise
Retrieve the seat map for flight order with ID 'XXX'
To retrieve the seat map of each flight included in a flight offer.
(Object
= {})
Promise<Response, ResponseError>:
a Promise
To retrieve the seat map of each flight included in flight offers for MAD-NYC flight on 2020-08-01.
A namespaced client for the
/v1/shopping/transfer-offers endpoints
Access via the Amadeus object
(Client)
To search the list of transfer offers.
(Object
= {})
Promise<Response, ResponseError>:
a Promise
To search the list of transfer offers
A namespaced client for the
/v1/travel/analytics/air-traffic endpoints
Access via the Amadeus object
(Client)
A namespaced client for the
/v1/travel/analytics/air-traffic/booked endpoints
Access via the Amadeus object
(Client)
Returns a list of air traffic reports based on the number of bookings.
Promise<Response, ResponseError>:
a Promise
Where were people flying to from Madrid in the August 2017?
A namespaced client for the
/v1/travel/analytics/air-traffic/busiest-period endpoints
Access via the Amadeus object
(Client)
Returns a list of air traffic reports.
Promise<Response, ResponseError>:
a Promise
What were the busiest months for Madrid in 2017?
A namespaced client for the
/v1/travel/analytics/air-traffic/traveled endpoints
Access via the Amadeus object
(Client)
Returns a list of air traffic reports based on the number of people traveling.
Promise<Response, ResponseError>:
a Promise
Where were people flying to from Madrid in the January 2017?
A namespaced client for the
/v1/travel/predictions/flight-delay endpoints
Access via the Amadeus object
(Client)
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.
(Object
= {})
| Name | Description |
|---|---|
params.originLocationCode string
|
city/airport IATA code to which the traveler is departing, e.g. PAR for Paris |
params.destinationLocationCode string
|
city/airport IATA code to which the traveler is departing, e.g. PAR for Paris |
params.departureDate string
|
the date on which the traveler will depart from the origin to go to the destination. Dates are specified in the ISO 8601 YYYY-MM-DD format, e.g. 2019-12-25 |
params.departureTime string
|
local time relative to originLocationCode on which the traveler will depart from the origin. Time respects ISO 8601 standard. e.g. 13:22:00 |
params.arrivalDate string
|
the date on which the traveler will arrive to the destination from the origin. Dates are specified in the ISO 8601 YYYY-MM-DD format, e.g. 2019-12-25 |
params.arrivalTime string
|
local time relative to destinationLocationCode on which the traveler will arrive to destination. Time respects ISO 8601 standard. e.g. 13:22:00 |
params.aircraftCode string
|
IATA aircraft code ( http://www.flugzeuginfo.net/table_accodes_iata_en.php ) |
params.carrierCode string
|
airline / carrier code |
params.flightNumber string
|
flight number as assigned by the carrier |
params.duration string
|
flight duration in ISO8601 PnYnMnDTnHnMnS format, e.g. PT2H10M |
Promise<Response, ResponseError>:
a Promise
Predict the segment where LH1009 (BRU-FRA) is likely to lay on 2020-01-14
A namespaced client for the
/v1/travel/predictions/trip-purpose endpoints
Access via the Amadeus object
(Client)
Forecast traveler purpose, Business or Leisure, together with the probability in the context of search & shopping.
(Object
= {})
| Name | Description |
|---|---|
params.originLocationCode string
|
city/airport IATA code from which the traveler will depart, e.g. BOS for Boston |
params.destinationLocationCode string
|
city/airport IATA code to which the traveler is going, e.g. PAR for Paris |
params.departureDate string
|
the date on which the traveler will depart from the origin to go to the destination. Dates are specified in the ISO 8601 YYYY-MM-DD format, e.g. 2017-12-25 |
params.returnDate string
|
the date on which the traveler will depart from the destination to return to the origin. Dates are specified in the ISO 8601 YYYY-MM-DD format, e.g. 2018-02-28 |
Promise<Response, ResponseError>:
a Promise
Forecast traveler purpose for a NYC-MAD round-trip between 2020-08-01 & 2020-08-12.