All things documentation for Pelias
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
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 Mark structured endpoint beta on documentation page Aug 17, 2018 s/Mapzen Search/Pelias/ Mar 15, 2018 s/Mapzen Search/Pelias/ Mar 15, 2018 Tweak the autocomplete page Mar 15, 2018
circle.yml Update circle.yml Mar 20, 2017 Remove old link Aug 6, 2018 Initial development roadmap Aug 6, 2018 Add full planet build considerations Jul 15, 2018 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 add response section Jul 5, 2017 Add Pelias from scratch install docs Jul 15, 2018 A little work on the place documentation Mar 15, 2018 Whitespace Mar 15, 2018 Add requirements document Jul 15, 2018 s/Mapzen Search/Pelias/ Mar 15, 2018 Formatting and URL fixes Aug 10, 2018 Tweak Reverse Mar 15, 2018 s/Mapzen Search/Pelias/ Mar 15, 2018 Remove Mapzen reference Jun 6, 2018 Add services documentation Jul 15, 2018 Add warning to start of structured doc Aug 17, 2018 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