Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention the clamp on boundary.circle.radius #285

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Mention the clamp on boundary.circle.radius #285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion reverse.md
View file
Open in desktop
Expand Up @@ -26,13 +26,15 @@ Parameter | Type | Required | Default | Example
--- | --- | --- | --- | ---
`point.lat` | floating point number | yes | none | `48.858268`
`point.lon` | floating point number | yes | none | `2.294471`
`boundary.circle.radius` | floating point number | no | 1 | `35`
`boundary.circle.radius` | floating point number | no | 1 | `5`
`size` | integer | no | `10` | `3`
`layers` | comma-delimited string array | no | none (all layers) | `address,locality`
`sources` | comma-delimited string array | no | none (all sources) | `oa,gn`
`boundary.country` | comma separated list of <a href="https://en.wikipedia.org/wiki/ISO_3166-1" target="\_blank">ISO-3166 alpha-2 or alpha-3</a> | no | none | `FR,GBR`
`boundary.gid` | Pelias `gid` | no | none | `whosonfirst:locality:101748355`

Note that `boundary.circle.radius` is limited to a radius of 5km to conserve disk I/O.

### Size

A basic parameter for filtering is `size`, which is used to limit the number of results returned. In the earlier request that returned the Eiffel Tower (or 'Tour Eiffel', to be exact), notice that other results were returned including "Bureau de Gustave Eiffel" (a museum) and "Le Jules Verne" (a restaurant). To limit a reverse geocode to only the first result, pass the `size` parameter:
Expand Down