pelias / pelias/api

Support addressing by various global standards

Open
#202 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

glorious future low priority processed story
Dominant language
JavaScript
Stars
259
Forks
168
Avg merge
6h 15m
Merged PRs (30d)
1

Description

We're primarily focused on letting people find places by how people refer to places; principally street addresses, areas, and points of interest. But there are other ways to place places.

These include:

When we detect one of these identifiers, we should be able to geocode to that region.

The wikipedia category on Geocoding Systems gives a pretty good overview, as does the comparison of systems done by open location codes.

Bonus Points

Reverse geocoding INTO these standards! You select a region, we'll give you the Open Location Code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or implementation entry points are named. Start by reviewing how the API currently detects and geocodes place identifiers, then define the supported standards and behavior for forward and optional reverse geocoding; done means the selected identifiers resolve reliably and the expected API responses are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.