map_viewport

app.offendersearch/offendersearch · Verify this server

Get what to draw for one map view: clusters, pins, or named pins. Send the view as `bbox`, or as `lat` + `lng` + `radius_miles`. The detail returned depends on the zoom the view is answered at (the response states it in `zoom`): - zoom 3-12 -> mode 'clusters': a count per grid cell. Each cluster has `count`, `bbox`, `breakdown` and `expansionZoom` (fit the map to `bbox` at that zoom and the cluster comes apart). - zoom 13-14 -> mode 'pins': one pin per address, position only, no name. - zoom 15+ -> mode 'markers': pins with `label` (first initial and last name), `housingStatus`, `hasPhoto`, `registryState`. A close view holding more than 300 pins is answered as clusters instead. Returns: { mode, zoom, bbox, datasetVersion, total, breakdown {street, housed, homeless, incarcerated}, clusters[], markers[], areas[], unplaced {count, states}, notice }. In radius mode also `center`, `radiusMiles` and `withinRadius` (exact), and each marker has `distanceMiles`. - A marker with `id: null` and a `groupId` stands for several people at one address: call map_group with that `groupId`. - `areas` are people placed only at the middle of a ZIP, city or county; each has a `groupId` too. Never describe them as being at an exact spot. - `unplaced` counts people in the states this view touches who have no mappable address. Mention it rather than implying the map shows everyone. - To see who one marker is, call map_open_record with its `id`. A pin shows a REGISTERED ADDRESS, not a person's current location — say so when you describe a result (`notice` carries the sentence). Billing: one map request per call ($2 per 1,000), whatever the view holds. Marker and group ids work for 24 hours. The Map API must be turned on for the account (the API answers 403 `map_not_enabled` otherwise); `sandbox=true` works without it. Auth: uses the caller's X-API-Key (request header or OFFENDERSEARCH_API_KEY env).