map_route

app.offendersearch/offendersearch · Verify this server

Exact counts of registered addresses along one walking or bus route. Counts a corridor either side of the line, a radius around each stop, or both, and returns exact numbers per leg and per stop with nameless pins and their distances. Never an estimate and never partial: the answer is complete or the call fails without a charge. Returns: { shape: 'route', profile, measure, detail, datasetVersion, complete, lengthMiles, corridorMiles, stopRadiusFeet, parcelAllowanceFeet, units, total, corridorTotal, stopsTotal, breakdown {street, housed, homeless, incarcerated}, legs: [ {leg, fromStop, toStop, lengthMiles, count} ], stops: [ {stopId, alongMiles, count, nearestFeet, markerIds} ], markers: [ {id, lat, lng, precision, addressType, distanceMiles, leg, alongMiles, nearestStop, stopDistanceFeet} ], groups[], approximate {count, areas[]}, unplaced {count, states}, externalId, notice, routeNotice }. - `total` = distinct people with a street address in the corridor or a stop's reach; leg counts sum to `corridorTotal`. - Pins carry NO NAMES. A `groups` entry (several people at one address) and an `approximate.areas` entry (people placed only at the middle of a ZIP, city or county; never in `total`) open with map_group. - To see who one marker is, call map_open_record with its `id` — a separate charge at the account's record-open rate (published price $0.035 per open; an account's agreed rate may differ). Open only the records the user asks for, not every marker on the route. - More than 300 pins at detail=full is a 422 `route_too_many_people` that carries the exact counts and is not charged: use detail='count' or split the route. A count shows REGISTERED ADDRESSES, NOT WHERE ANYONE IS, and is not a rating of the route. Never describe a route as safe or unsafe; relay `notice` and `routeNotice`. It supports the user's process; it is not a legal determination. Billing: route units, each one map request ($2 per 1,000): one per started mile of measured corridor plus one per 10 stops when stop radii are measured (minimum 1); `units` in the answer says how many. detail='count' costs the same. E.g. a 17.4-mile bus route with 35 stops = 18 + 4 = 22 units. Test mode is free. The Map API must be turned on for the account. Auth: uses the caller's X-API-Key (request header or OFFENDERSEARCH_API_KEY env).