You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-7Lines changed: 21 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,14 +79,28 @@ The Geocode Earth dataset is a combination of multiple data sources. This attrib
79
79
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.
80
80
81
81
### `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
+
82
86
### `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)
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.
0 commit comments