This documentation covers a service that is currently in public beta. While we make a reasonable effort to ensure that things stay online, our beta services are not subject to the same availability guarantees of our other services. Additionally, beta services may not have the same global redundancy as our other services, so latency may be higher.
You will not be charged for beta access. If you continue using the service once it goes live, you will be charged as usual per the terms of our public pricing or your enterprise agreement.
Please send any feedback and issue reports to firstname.lastname@example.org.
Most components of each geocoding response include a unique identifier in the form of a
For example, if you search for an address, you may want to find out more about the
You can get more information by looking up the result's
localadmin_gid with the
Query String Parameters¶
||comma-delimited string array||yes||A list of Pelias GIDs to search for.||none||
Notes and tips¶
- Not all types of data have searchable GIDs. For example, interpolated addresses are derived data and are not
searchable (but other attributes of the response, such as the
regiongenerally will). Specifically, only GIDs of type
- Some sources do not guarantee stability of IDs over time, so caching them may lead to unexpected results. In general, Geonames and Who's on First are more curated and try to ensure IDs remain stable, but OpenAddresses and OpenStreetMap IDs are inherently unstable.
All geocoding, autocomplete, and search endpoints share a common response format. See the response format documentation for details. This endpoint will likely be extended in the future.