Skip to content

Commit f55c2ac

Browse files
committed
docs: document remaining API params
1 parent 2a1de1b commit f55c2ac

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,28 @@ The Geocode Earth dataset is a combination of multiple data sources. This attrib
7979
Sets latitude and longitude around which to focus results. In addition to providing results that are more relevant due to their proximity, setting a focus point is generally significantly faster than an unfocused query.
8080
8181
### `boundary.country`
82+
> defaults to unset (all countries)
83+
84+
Sets a country filter to only return results in the specified country. Use a comma separated list of [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) country codes (2 or 3 letter variants).
85+
8286
### `boundary.gid`
83-
### `boundary.circle.lat`
84-
### `boundary.circle.lon`
85-
### `boundary.circle.radius`
86-
### `boundary.rect.min_lat`
87-
### `boundary.rect.max_lon`
88-
### `boundary.rect.max_lat`
89-
### `boundary.rect.min_lon`
87+
> defaults to unset (all GIDs)
88+
89+
Filters results by parent ID, which can be used to search in areas smaller than a country and/or areas with shapes not well represented by rectangular bounding boxes.
90+
91+
[Please see our documentation how to use this.](https://geocode.earth/docs/forward/customization/#restrict-results-by-parent-id)
92+
93+
### `boundary.circle.lat`, `boundary.circle.lon`, `boundary.circle.radius`
94+
> defaults to unset
95+
96+
Searches within a circular region. Useful to return results in a radius around a known point. Note: all three parameters need to be set. The `radius` is defined in kilometers.
97+
98+
### `boundary.rect.min_lat`, `boundary.rect.max_lon`, `boundary.rect.max_lat`, `boundary.rect.min_lon`
99+
> defaults to unset
100+
101+
Searches within a rectangular region. Same as with a circular boundary all 4 parameters have to be set.
102+
103+
Tip: You can look up a bounding box for a known region using [geojson.io](https://geojson.io/).
90104
91105
## Events
92106

0 commit comments

Comments
 (0)