close

Sign in

To view secure documentation please login with EAN Service Desk, using the link below.

EAN service desk

No EAN Service Desk account?

Please contact your EAN representative

Login
Sign in
Rapid

EAN Rapid Geography Version 2

The EAN Geography APIs provide you with access to geographic definitions and property mappings for over 400,000 regions.

Region Descendants

Returns the geographic definition and property mappings of all hierarchical descendants for the requested Region ID. To request all regions in the world, specific the Region ID of 0 (zero). To request all regions in a specific continent, country or other level, specify the Region ID of that region. Refer to the list of top level regions to get started. Use this API to build out your geography database.

Region

Returns the geographic definition and property mappings for the requested Region ID. Use this API to retrieve geography information for a known Region ID.

Notes

Region Types
The type object explains the geographic entity represented such as city or neighborhood. Refer to the list of region types for detailed descriptions.

Localization
The language object only uses hyphenated pairs of two-digit language and country codes - see parameter entry for details. Review our supported languages before integrating any codes. Only the name and name_full fields in the responses are provided in the requested language. All other geography definitions in the response will be in English.

Polygons
The bounding_polygon object provides the list of coordinates that encompass the shape of the region. Regions can cover areas represented by either a single polygon or multiple polygons. Region types that are represented by a single coordinate (e.g. point of interest, train station, etc.) do not have a bounding polygon. The bounding_polygon object follows the GeoJSON standard with the longitude value listed first followed by latitude when providing lists of coordinates.

Hierarchy
The relationship between regions is provided using the ancestors and descendants objects. Due to geographical and political variations throughout the world, region types do not have a strict hierarchy. Logically, however, a city is typically associated with a multi-city, province/state or country. To derive the hierarchy of a specific region, use the ancestors values.

  • ancestors represent the levels of hierarchy above a given region. For example, the direct ancestor of the multi-city of Athens, Greece is the region of Attica and further up the hierarchy its ancestors include Greece and Europe. A region may have more than one parent. Since the multi-city of Geneva is on the border of Switzerland and France, it will have ancestors in both countries.
  • descendants represent the levels of hierarchy below a given region. In our example, the city of Piraeus, Greece is a descendant of the multi-city of Athens, Greece. The descendants map within a region object only contains the direct children (one level down) of that region.

Property Mappings
Property mappings are provided in both the Region Descendants API and the Region API. Region types with property mappings are: high_level_region, state_province, multi_city_vicinity, city, neighborhood, point_of_interest, and select countries. Property mappings are available in two options:

  • property_ids: This option provides only the properties within the region's polygon. The polygon is the bounding shape that represents the region’s area.
  • property_ids_expanded: If the region’s polygon does not contain at least 100 properties, this option provides the properties within the polygon in addition to properties within a 30km radius of the region. This expanded set of properties should ensure that enough properties are presented in hotel search results for a destination. For region types represented by a single coordinate rather than a polygon (e.g. point_of_interest), only this expanded option will provide associated property mappings.

Download the Swagger description of the Geography API or a full description containing all APIs

Previous API Documentation - New Location

Looking for docs for your V3 integration? Simply sign in to your account on support.ean.com to view all documentation for our previous V3 API.
Contact your EAN representative if you need assistance with your support.ean.com account - docs are not available without an account.