pelias
/
documentation
mirror of https://github.com/pelias/documentation.git
1
0
Fork 0
Code Issues Releases Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
667 Commits
5 Branches
0 Tags
13 MiB
 
Tree: b06fef01c4
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b06fef01c4'
${ noResults }
Julian Simioni b06fef01c4
Add requirements document 		6 years ago
images crop image vertically 8 years ago
.gitignore Stop tracking OSX .DS_Store files 9 years ago
LICENSE.md Changes license from MIT (which applies to code only) to CC-BY-4.0 to apply to creative works 9 years ago
README.md Add link to workflow page 7 years ago
add-search-to-a-map.md s/Mapzen Search/Pelias/ 7 years ago
addresses.md s/Mapzen Search/Pelias/ 7 years ago
autocomplete.md Tweak the autocomplete page 7 years ago
circle.yml Update circle.yml 8 years ago
data-sources.md De-Mapzenify data source documentation 7 years ago
full_planet_considerations.md Add full planet build considerations 6 years ago
glossary.md Add administrative area definition 6 years ago
http-status-codes.md remove reference to API rate limiter errors 8 years ago
installing.md replace text with link to new location 8 years ago
language-codes.md add response section 7 years ago
pelias_from_scratch.md Add Pelias from scratch install docs 6 years ago
place.md A little work on the place documentation 7 years ago
release-notes.md Whitespace 7 years ago
requirements.md Add requirements document 6 years ago
response.md s/Mapzen Search/Pelias/ 7 years ago
result_quality.md Add more details to result quality page 7 years ago
reverse.md Tweak Reverse 7 years ago
search-workflows.md s/Mapzen Search/Pelias/ 7 years ago
search.md Remove Mapzen reference 7 years ago
services.md Add services documentation 6 years ago
structured-geocoding.md s/whosonfirst.mapzen.com/whosonfirst.org/ 7 years ago
use-cors.md s/Mapzen Search/Pelias/ 7 years ago

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) 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

Misc