|
|
|
# Pelias Documentation
|
|
|
|
|
|
|
|
Here is where you can find all documentation for the [Pelias geocoder](https://github.com/pelias/pelias/).
|
|
|
|
|
|
|
|
## Table of Contents
|
|
|
|
|
|
|
|
### Core Features and API Documentation
|
|
|
|
- [Forward geocoding](search.md) to find a place by searching for an address or name
|
|
|
|
- [Reverse geocoding](reverse.md) to find what is located at a certain coordinate location
|
|
|
|
- [Autocomplete](autocomplete.md) to give real-time result suggestions without having to type the whole location
|
|
|
|
- [Global coverage with prioritized local results](search.md#prioritize-results-by-proximity)
|
|
|
|
- [Structured Geocoding](structured-geocoding.md) to find a place with data already separated into housenumber, street, city, etc
|
|
|
|
- [Glossary of common terms](glossary.md)
|
|
|
|
|
|
|
|
### Data Sources
|
|
|
|
- [Pelias data sources](data-sources.md)
|
|
|
|
- [Tools for embedding search](https://mapzen.com/documentation/mapzen-js/search/) in a map
|
|
|
|
|
|
|
|
### Running your own Pelias
|
|
|
|
- [Pelias installation guide](https://github.com/pelias/pelias/blob/master/INSTALL.md)
|