Pelias Documentation

Here is where you can find all documentation for the Pelias geocoder.

Table of Contents

Core Features and API Documentation

Endpoint descriptions

• Forward geocoding (/v1/search) to find a place by searching for an address or name
• Reverse geocoding (/v1/reverse) to find what is located at a certain coordinate location
• Autocomplete (/v1/autocomplete) to give real-time result suggestions without having to type the whole location
• Structured Geocoding (/v1/search/structured) to find a place with data already separated into housenumber, street, city, etc
• Place endpoint (/v1/place) for details on a place returned from a previous query

Query parameters and options

• Global coverage with prioritized local results
• Language support for seeing results in different languages

Response Properties

• Confidence scores, match_types and other tools for determining result quality

Data Sources

• Pelias data sources

Running your own Pelias

• Pelias installation guide

Pelias project development

• Release notes. See notable changes in Pelias over time

Misc

• Glossary of common terms