map

Up to 50 routes in one call, answered all or nothing

Changed on

Up to 50 routes, each shaped like a POST /v1/map/route body, answered in one call. Every route answers, or none does: one invalid route is a 422 naming its routeIndex, one route over 300 pins (with detail=full) is 422 route_too_many_people naming its routeIndex, and a failed read is a 503. Nothing is billed unless the whole batch answers.

All the markers share one response, so a person on three routes opened from this answer is one record open. A batch answers in JSON only.

Billing. The sum of the routes' units, each one map request.

post/v1/map/routes

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/map/routes
  • Auth: API key in header X-API-Key

Headers

X-End-Userstring

Any id you use for the end user behind this request. The daily area budget is then also counted per end user (2,000 distinct areas a day), so one heavy user is limited before the account is; on the route routes, so is the number of different routes a day, and on the records route the daily open limit when one is set. Optional with a secret key; required on the route routes with a map browser key (422 end_user_required).

Request body

sandboxboolean

true answers every route in test mode.

Response

Every route's answer, in the order sent.

shape'routes'
completeboolean

Always true: the batch is answered whole or refused.

datasetVersionstring date
unitsinteger

The sum of the routes' units.

uniquePeopleinteger

Distinct people across every route.

sandboxboolean

Present and true on a test-mode answer.

noticestring

Example response

{
  "routes": [
    {
      "datasetVersion": "2026-10-18",
      "approximate": {
        "areas": [
          {
            "place": "43215"
          }
        ]
      },
      "unplaced": {
        "states": [
          "OH"
        ]
      },
      "notice": "A pin shows a registered address, not a person's current location."
    }
  ]
}

Changes