Request Parameters
The full body for POST /v1/stream, grouped by purpose.
Search
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
queryRequired | string | Required | — | Natural-language description of what to find (e.g. “potholes in new york”). |
Location
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
region_idOptional | string | Optional | — | Numeric region id for an exact city/state/country scope. |
positionOptional | object | Optional | — | Object with a points array of latitude/longitude objects. Set one position or multiple positions. |
Time
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
yearOptional | number | Optional | all | Restricts results to captures from one specific calendar year. |
start_dateOptionalAvailable on Scale, Business | string | Optional | — | Lower bound of the capture window (ISO-8601). |
end_dateOptionalAvailable on Scale, Business | string | Optional | — | Upper bound of the capture window (ISO-8601). |
Results
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
limitOptional | number | Optional | 50 | Maximum GeoJSON features returned (capped at 50). |
Tier gates are indicative — use Usage Tiers for the authoritative capability split.