Skip to content
All things documentation for Pelias
Branch: master
Clone or download
Latest commit 41376d4 Mar 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
development Remove importer speed roadmap goal Jan 29, 2019
images crop image vertically Sep 22, 2016
.gitignore
LICENSE.md
README.md
add-search-to-a-map.md Remove trailing spaces and some links to mapzen Sep 5, 2018
addresses.md Remove trailing spaces and some links to mapzen Sep 5, 2018
autocomplete.md
circle.yml
data-sources.md
full_planet_considerations.md
getting_started_install.md
glossary.md Add administrative area definition Jul 10, 2018
http-status-codes.md remove reference to API rate limiter errors Apr 28, 2017
installing.md Link to new install guide index Aug 7, 2018
language-codes.md Remove trailing spaces and some links to mapzen Sep 5, 2018
pelias_from_scratch.md Fix typos Mar 17, 2019
place.md Remove references to API key Mar 4, 2019
release-notes.md link fixed : mapzen-->pelis.github.io Nov 27, 2018
requirements.md fixed typo in title Mar 11, 2019
response.md
result_quality.md
reverse.md Add documentation for `boundary.gid` parameter Mar 5, 2019
search-workflows.md
search.md
services.md
structured-geocoding.md
use-cors.md s/Mapzen Search/Pelias/ Mar 15, 2018

README.md

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) (beta) 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

Not sure which Endpoint to use? We have a page for that

Query parameters and options

Response Properties

Data Sources

Running your own Pelias

Pelias project development

  • Release notes. See notable changes in Pelias over time
  • Development roadmap. Plans for future improvements to Pelias. Read this to see what's coming and how you can help

Misc

You can’t perform that action at this time.