v1

latestOpenAPI 3.1.02026-07-243613262.4 KB
All

Find all types of locations

This endpoint returns the locations that match a partial string passed as query parameter (query) or matches exactly a specific field (locode, iataCode or postalCode). Only one of these fields must be used in a request. Locations returned can be either airport, port, zipcode, railTerminal or roadTerminal.

The query parameter locationTypes allows to filter the types returned. A list of values can be passed among port,airport,zipcode,railTerminal, roadTerminal. If this parameter is not passed in the query, all the types will be searched.

The query parameter sizes allows to filter the sizes of the locations returned for ports and airports.

The results are returned with this priority order : port > airport > railTerminal > zipcode > roadTerminal.

For each location, geometry (coordinates) is returned as well as properties fields. These fields differ according to the type of the location.

For airports : name, locode, size, iataCode, countryName, countryCode (as a two letters code).

For zipcodes : name, country, countryName, postalCode, stateCode, stateName, countyCode, countyName.

For ports : name, locode, size, countrycountryName, subdivisionCode, subdivisionName.

For ports, rail terminals and road terminals : name, locode, countrycountryName, subdivisionCode, subdivisionName.

get/geocoding/v2/all

Query parameters

querystring
Example:Montreal

A partial string used for search. For instance, part of an airport name or part of a locode

postalCodestring

A string denoting the postal code.

locodestring
Example:FRMRS

A string representing the locode of the searched airport.

iataCodestring
Example:YUL

A string representing the iata code of the searched airport.

locationTypesstring
Example:port,airport,railTerminal

A list of strings used to filter the location types. Permitted values are port, airport, zipcode, railTerminal, roadTerminal. If not passed, all the types will be taken into account.

sizesstring
Example:large,medium

A list of strings used to filter the location by size. Permitted values are large, medium, small. Note that this parameter is available for airports search only. If not passed, all the sizes will be taken into account.

countryCodesstring
Example:DE,FR

A list of country codes (2 characters ISO) used to filter the location by country.

excludeCountryCodesstring
Example:US,CA

A list of country codes (2 characters ISO) used to exclude location of some countries.

Response

OK

All 36 operations