Skip to content
All things documentation for Pelias
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
development Switch roadmap from ES5 to ES6 May 7, 2019
images crop image vertically Sep 22, 2016
.gitignore Stop tracking OSX .DS_Store files Sep 29, 2015 Changes license from MIT (which applies to code only) to CC-BY-4.0 to… Apr 13, 2016 Add response contents documentation to main index Jul 8, 2019 Remove trailing spaces and some links to mapzen Sep 5, 2018 Remove trailing spaces and some links to mapzen Sep 5, 2018 Merge pull request #249 from mihneadb/patch-2 Apr 30, 2019
circle.yml Update circle.yml Mar 20, 2017 Remove old link Aug 6, 2018 Correct a spelling error May 28, 2019 Add getting started installation guide Aug 6, 2018 Add administrative area definition Jul 10, 2018 remove reference to API rate limiter errors Apr 28, 2017 Link to new install guide index Aug 7, 2018 Remove trailing spaces and some links to mapzen Sep 5, 2018 Remove outdated section Aug 19, 2019 Remove references to API key Mar 4, 2019 link fixed : mapzen--> Nov 27, 2018 Update Elasticsearch requirements May 7, 2019 Remove api_key from response documentation Aug 16, 2019 Formatting and URL fixes Aug 10, 2018 Doc for multi `` query parameter Apr 24, 2019 Remove Mapzen pricing information from documentation Jul 17, 2019 Merge pull request #250 from mihneadb/patch-3 Apr 30, 2019 Add links to libpostal-service repo Dec 16, 2018 fixed the actual link Mar 13, 2019 s/Mapzen Search/Pelias/ Mar 15, 2018

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


You can’t perform that action at this time.