Reference

IATA airport code (3 letters). Whole-city codes such as LON work when the data contains them.

Example: DXB

ICAO airport code (4 letters).

Example: OMDB

ISO 3166-1 alpha-2 country code.

Example: AE

ISO 3166-1 alpha-3 country code.

Example: ARE

ISO 3166-1 numeric country code. Leading zeros are optional (28 = 028).

Example: 784

Origin: where the traveller comes from. Accepted and recorded now; used to skip don'ts the traveller already knows from home once the origin logic is active. An unknown origin never makes the call fail; it gives a warning.

Example: ZRH

Origin as ICAO airport code. See from_iata.

Origin as ISO alpha-2 country code. See from_iata.

Origin as ISO alpha-3 country code. See from_iata.

Origin as ISO numeric country code. See from_iata.

How many don'ts per page, best first (1 to 100, default 100). limit=10 gives the top 10. Values above 100 are treated as 100 and noted in warnings.

Example: 10

Which page, starting at 1. Ranks continue across pages (page 2 with limit=10 starts at rank 11).

Include picture links (yes, default) or leave them out (no). The PDF always has pictures.

Answer format. All formats come from the same ranked answer. A PDF counts as several calls.

yes leaves out all optional fields (input, origin, method, data_version, references) and returns only the place, the counts, the warnings and the don'ts. Default no.

Language. Only en for now; any other value is answered in English with a warning.

Your own reference, for example a booking number (up to 100 characters), echoed back and logged if your plan stores it. Never put personal data here (names, emails, passport numbers).

Second reference field. See ref1.

Third reference field. See ref1.

The don'ts for the destination, best first.

The call is not complete or not valid (missing_destination, invalid_code, invalid_parameter, page_out_of_range).

No key, or the key is not valid (missing_key, invalid_key).

A new month of the plan started unpaid, so every key of the account is paused (payment_due). Update the payment in My account on the developer portal; the keys work again as soon as the payment arrives.

The key is switched off, or the plan does not include this (key_disabled, format_not_in_plan, sample_place_only).

The code is not known, or the address does not exist (unknown_address).

Two different cases: too_fast: more calls per second than the plan allows; wait the seconds in Retry-After. limit_reached: the allowance is used up (free and small-developer plans), or a plan that continues above it reached its stop.

Something went wrong on our side (internal_error). Carry on without the don'ts, for example send the confirmation email without the PDF, and try again later.

The API is temporarily unavailable (unavailable), or only the PDF could not be made (pdf_unavailable). Same advice as internal_error; after pdf_unavailable the same call with format=json usually works.

Example: NRT

Origin: where the traveller comes from. Accepted and recorded now; used to skip don'ts the traveller already knows from home once the origin logic is active. An unknown origin never makes the call fail; it gives a warning.

Example: ZRH

Origin as ICAO airport code. See from_iata.

Origin as ISO alpha-2 country code. See from_iata.

Origin as ISO alpha-3 country code. See from_iata.

Origin as ISO numeric country code. See from_iata.

How many don'ts per page, best first (1 to 100, default 100). limit=10 gives the top 10. Values above 100 are treated as 100 and noted in warnings.

Example: 10

Which page, starting at 1. Ranks continue across pages (page 2 with limit=10 starts at rank 11).

Include picture links (yes, default) or leave them out (no). The PDF always has pictures.

Answer format. All formats come from the same ranked answer. A PDF counts as several calls.

yes leaves out all optional fields (input, origin, method, data_version, references) and returns only the place, the counts, the warnings and the don'ts. Default no.

Language. Only en for now; any other value is answered in English with a warning.

Your own reference, for example a booking number (up to 100 characters), echoed back and logged if your plan stores it. Never put personal data here (names, emails, passport numbers).

Second reference field. See ref1.

Third reference field. See ref1.

The don'ts for the destination, best first.

The call is not complete or not valid (missing_destination, invalid_code, invalid_parameter, page_out_of_range).

No key, or the key is not valid (missing_key, invalid_key).

A new month of the plan started unpaid, so every key of the account is paused (payment_due). Update the payment in My account on the developer portal; the keys work again as soon as the payment arrives.

The key is switched off, or the plan does not include this (key_disabled, format_not_in_plan, sample_place_only).

The code is not known, or the address does not exist (unknown_address).

Two different cases: too_fast: more calls per second than the plan allows; wait the seconds in Retry-After. limit_reached: the allowance is used up (free and small-developer plans), or a plan that continues above it reached its stop.

Something went wrong on our side (internal_error). Carry on without the don'ts, for example send the confirmation email without the PDF, and try again later.

The API is temporarily unavailable (unavailable), or only the PDF could not be made (pdf_unavailable). Same advice as internal_error; after pdf_unavailable the same call with format=json usually works.

Example: JP

Origin: where the traveller comes from. Accepted and recorded now; used to skip don'ts the traveller already knows from home once the origin logic is active. An unknown origin never makes the call fail; it gives a warning.

Example: ZRH

Origin as ICAO airport code. See from_iata.

Origin as ISO alpha-2 country code. See from_iata.

Origin as ISO alpha-3 country code. See from_iata.

Origin as ISO numeric country code. See from_iata.

How many don'ts per page, best first (1 to 100, default 100). limit=10 gives the top 10. Values above 100 are treated as 100 and noted in warnings.

Example: 10

Which page, starting at 1. Ranks continue across pages (page 2 with limit=10 starts at rank 11).

Include picture links (yes, default) or leave them out (no). The PDF always has pictures.

Answer format. All formats come from the same ranked answer. A PDF counts as several calls.

yes leaves out all optional fields (input, origin, method, data_version, references) and returns only the place, the counts, the warnings and the don'ts. Default no.

Language. Only en for now; any other value is answered in English with a warning.

Your own reference, for example a booking number (up to 100 characters), echoed back and logged if your plan stores it. Never put personal data here (names, emails, passport numbers).

Second reference field. See ref1.

Third reference field. See ref1.

The don'ts for the destination, best first.

The call is not complete or not valid (missing_destination, invalid_code, invalid_parameter, page_out_of_range).

No key, or the key is not valid (missing_key, invalid_key).

A new month of the plan started unpaid, so every key of the account is paused (payment_due). Update the payment in My account on the developer portal; the keys work again as soon as the payment arrives.

The key is switched off, or the plan does not include this (key_disabled, format_not_in_plan, sample_place_only).

The code is not known, or the address does not exist (unknown_address).

Two different cases: too_fast: more calls per second than the plan allows; wait the seconds in Retry-After. limit_reached: the allowance is used up (free and small-developer plans), or a plan that continues above it reached its stop.

Something went wrong on our side (internal_error). Carry on without the don'ts, for example send the confirmation email without the PDF, and try again later.

The API is temporarily unavailable (unavailable), or only the PDF could not be made (pdf_unavailable). Same advice as internal_error; after pdf_unavailable the same call with format=json usually works.

IATA airport code (3 letters). Whole-city codes such as LON work when the data contains them.

Example: DXB

ICAO airport code (4 letters).

Example: OMDB

ISO 3166-1 alpha-2 country code.

Example: AE

ISO 3166-1 alpha-3 country code.

Example: ARE

ISO 3166-1 numeric country code. Leading zeros are optional (28 = 028).

Example: 784

How many don'ts per page, best first (1 to 100, default 100). limit=10 gives the top 10. Values above 100 are treated as 100 and noted in warnings.

Example: 10

Which page, starting at 1. Ranks continue across pages (page 2 with limit=10 starts at rank 11).

Include picture links (yes, default) or leave them out (no). The PDF always has pictures.

Answer format. All formats come from the same ranked answer. A PDF counts as several calls.

yes leaves out all optional fields (input, origin, method, data_version, references) and returns only the place, the counts, the warnings and the don'ts. Default no.

The don'ts for the destination, best first.

The call is not complete or not valid (missing_destination, invalid_code, invalid_parameter, page_out_of_range).

The key is switched off, or the plan does not include this (key_disabled, format_not_in_plan, sample_place_only).

The code is not known, or the address does not exist (unknown_address).

Two different cases: too_fast: more calls per second than the plan allows; wait the seconds in Retry-After. limit_reached: the allowance is used up (free and small-developer plans), or a plan that continues above it reached its stop.

Something went wrong on our side (internal_error). Carry on without the don'ts, for example send the confirmation email without the PDF, and try again later.

The API is temporarily unavailable (unavailable), or only the PDF could not be made (pdf_unavailable). Same advice as internal_error; after pdf_unavailable the same call with format=json usually works.

The API is running.

The API is temporarily unavailable (unavailable), or only the PDF could not be made (pdf_unavailable). Same advice as internal_error; after pdf_unavailable the same call with format=json usually works.