Skip to content
All things documentation for Pelias
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
development Update roadmap intro Mar 23, 2020
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 docs: add project header to readme (#274) May 28, 2020
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 Merge pull request #249 from mihneadb/patch-2 Apr 30, 2019
data-sources.md Remove old link Aug 6, 2018
full_planet_considerations.md Update full_planet_considerations.md Feb 10, 2020
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 Remove trailing spaces and some links to mapzen Sep 5, 2018
pelias_from_scratch.md Update recommended elasticsearch version Nov 27, 2019
place.md Update OSM GID format Mar 5, 2020
release-notes.md Add links to per-repository release notes Mar 10, 2020
requirements.md Update to recommending ES7 over ES6 Mar 13, 2020
response.md Fix documentation on distance units (#269) Feb 14, 2020
result_quality.md Formatting and URL fixes Aug 10, 2018
reverse.md Fix documentation on distance units (#269) Feb 14, 2020
search-workflows.md Remove Mapzen pricing information from documentation Jul 17, 2019
search.md Update search.md Apr 25, 2020
services.md Update services.md Nov 27, 2019
structured-geocoding.md fixed the actual link Mar 13, 2019
use-cors.md s/Mapzen Search/Pelias/ Mar 15, 2018

README.md

A modular, open-source search engine for our world.

Pelias is a geocoder powered completely by open data, available freely to everyone.

Local Installation · Cloud Webservice · Documentation · Community Chat

What is Pelias?
Pelias is a search engine for places worldwide, powered by open data. It turns addresses and place names into geographic coordinates, and turns geographic coordinates into places and addresses. With Pelias, you’re able to turn your users’ place searches into actionable geodata and transform your geodata into real places.

We think open data, open source, and open strategy win over proprietary solutions at any part of the stack and we want to ensure the services we offer are in line with that vision. We believe that an open geocoder improves over the long-term only if the community can incorporate truly representative local knowledge.

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.