Skip to content

pelias/documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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