For the complete documentation index, see llms.txt. This page is also available as Markdown.

Minimum Inputs

The query field specifies the place to be matched. Each query must have non-blank values for at least one of the following combinations to get a Placekey:

  • query.street_address + query.city + query.region + query.postal_code + query.iso_country_code

  • query.street_address + query.region + query.postal_code + query.iso_country_code

  • query.street_address + query.city + query.region + query.iso_country_code

  • query.latitude + query.longitude

Include as much detail as possible in the query for the best match.

How Inputs Affect the Response

An address is required to get a POI or address Placekey (the What@Where format). When you include a location_name, the API matches it against known POIs at that address.

Coordinates alone return only the Where part of a Placekey (the H3 hexagon). This can also be computed locally using the Python or JavaScript libraries without an API call.

When both address and coordinates are provided, the address drives the match. Including coordinates alongside an address is encouraged as it helps improve match quality.

Last updated