Reference¶

Client¶

class amadeus.Client(**options)[source]¶

The Amadeus client library for accessing the travel APIs.

__init__(**options)[source]¶

Initialize using your credentials:

from amadeus import Client

amadeus = Client(
    client_id='YOUR_CLIENT_ID',
    client_secret='YOUR_CLIENT_SECRET'
)

Alternatively, initialize the library using the environment variables AMADEUS_CLIENT_ID and AMADEUS_CLIENT_SECRET.

amadeus = amadeus.Client()

Parameters

client_id (str) – the API key used to authenticate the API
client_secret (str) – the API secret used to authenticate the API
logger (logging.Logger) – (optional) a Python compatible logger (Default: logging.Logger)
log_level (str) – (optional) the log level of the client, either "debug", "warn", or "silent" mode (Default: "silent")
hostname (str) – (optional) the name of the server API calls are made to, "production" or "test". (Default: "test")
host (str) – (optional) alternatively, you can specify a full host domain name instead, e.g. "api.example.com"
ssl (bool) – if this client is should use HTTPS (Default: True)
port (int) – the port this client should use (Default: 80 for HTTP and 443 for HTTPS)
custom_app_id (str) – (optional) a custom App ID to be passed in the User Agent to the server (Default: None)
custom_app_version (str) – (optional) a custom App Version number to be passed in the User Agent to the server (Default: None)
http (urllib.request.urlopen) – (optional) a urllib.request.urlopen() compatible client that accepts a urllib.request.Request compatible object (Default: urlopen)

Raises

ValueError – when a required param is missing

get(path, **params)¶

A helper function for making generic GET requests calls. It is used by every namespaced API GET method.

It can be used to make any generic API call that is automatically authenticated using your API credentials:

amadeus.get('/foo/bar', airline='1X')

Parameters

path (str) – path the full path for the API call
params (dict) – (optional) params to pass to the API

Return type

amadeus.Response

Raises

amadeus.ResponseError – when the request fails

post(path, params=None)¶

A helper function for making generic POST requests calls. It is used by every namespaced API POST method.

It can be used to make any generic API call that is automatically authenticated using your API credentials:

amadeus.post('/foo/bar', airline='1X')

Parameters

path (str) – path the full path for the API call
params (dict) – (optional) params to pass to the API

Return type

amadeus.Response

Raises

amadeus.ResponseError – when the request fails

request(verb, path, params)¶

A helper function for making generic POST requests calls. It is used by every namespaced API method. It can be used to make any generic API call that is automatically authenticated using your API credentials:

amadeus.request('GET', '/foo/bar', airline='1X')

Parameters

verb (str) – the HTTP verb to use
path (str) – path the full path for the API call
params (dict) – (optional) params to pass to the API

Return type

amadeus.Response

Raises

amadeus.ResponseError – when the request fails

Response¶

class amadeus.Response(http_response, request)[source]¶

The response object returned for every API call.

Variables

http_response – the raw http response
request (amadeus.Request) – the original Request object used to make this call
result (dict) – the parsed JSON received from the API, if the result was JSON
data (dict) – the data extracted from the JSON data, if the body contained JSON
body (str) – the raw body received from the API
parsed (bool) – wether the raw body has been parsed into JSON
status_code (int) – The HTTP status code for the response, if any

ResponseError¶

class amadeus.ResponseError(response)[source]¶

An Amadeus error

Variables

response (amadeus.Response) – The response object containing the raw HTTP response and the request used to make the API call.
code (str) – A unique code for this type of error. Options include NetworkError, ParserError, ServerError, AuthenticationError, NotFoundError and UnknownError.

class amadeus.AuthenticationError(response)[source]¶