geocode
Convert street addresses, POIs, or areas into geographic coordinates and contextual data like country, city, and additional details such as population or website using precise search parameters.
Instructions
Look up a street address, POI, or area. Returned geographic information includes coordinates, bounding box, local context (what country, city, etc. is it in).. Additional info may include Wikipedia ID, population, opening hours, website, and more, subject to availability.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
countryFilter | No | ||
focusPoint | No | Geographic coordinates to focus the search around. Provide this whenever possible. | |
lang | Yes | A BCP-47 language tag (may just be the language) to localize the results in (e.g. en, de, et). | |
layer | No | The layer to search in. Coarse searches for areas such as neighborhoods, cities, states, and countries, AND a specific layer is not available. Address searches for street addresses. Country is what you expect. Localities are what we would colloquially refer to as a 'city', town, or village. Region is for first-level subdivisions within countries like states, provinces, or whatever they are called locally. POI searches for points of interest including restaurants, parks, shops, and museums. Defaults to all layers if not specified. | |
query | Yes | The address or place name to search for. Use local formatting and order when possible. When searching for a POI name (e.g. 'Starbucks'), you will get better results with a focus point and filters. Avoid spelling out precise locations (e.g. 'Starbucks, Downtown Greenville'); this is acceptable for large areas though (e.g. 'Paris, France' is OK, as is 'Louvre, Paris'). Make multiple queries or use general knowledge when necessary to identify the correct non-textual filters. |