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.
Permalink
Failed to load latest commit information.
images crop image vertically Sep 22, 2016
.gitignore Stop tracking OSX .DS_Store files Sep 29, 2015
LICENSE.md Changes license from MIT (which applies to code only) to CC-BY-4.0 to… Apr 13, 2016
README.md Mark structured endpoint beta on documentation page Aug 17, 2018
add-search-to-a-map.md s/Mapzen Search/Pelias/ Mar 15, 2018
addresses.md s/Mapzen Search/Pelias/ Mar 15, 2018
autocomplete.md Tweak the autocomplete page Mar 15, 2018
circle.yml Update circle.yml Mar 20, 2017
data-sources.md Remove old link Aug 6, 2018
development_roadmap.md Initial development roadmap Aug 6, 2018
full_planet_considerations.md Add full planet build considerations Jul 15, 2018
getting_started_install.md Add getting started installation guide Aug 6, 2018
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 add response section Jul 5, 2017
pelias_from_scratch.md Add Pelias from scratch install docs Jul 15, 2018
place.md A little work on the place documentation Mar 15, 2018
release-notes.md Whitespace Mar 15, 2018
requirements.md Add requirements document Jul 15, 2018
response.md s/Mapzen Search/Pelias/ Mar 15, 2018
result_quality.md Formatting and URL fixes Aug 10, 2018
reverse.md Tweak Reverse Mar 15, 2018
search-workflows.md s/Mapzen Search/Pelias/ Mar 15, 2018
search.md Remove Mapzen reference Jun 6, 2018
services.md Add services documentation Jul 15, 2018
structured-geocoding.md Add warning to start of structured doc Aug 17, 2018
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