offenders.io drop-in compatibility (POST)
Accepts offenders.io's exact parameters and returns their exact envelope ({offenders, page, totalPages[, error]}). Existing offenders.io integrations switch by changing only the base URL and key. Accepts the key via X-API-Key, Authorization: Bearer, or ?key=. Echoes/mints the offenders.io correlation headers (X-Request-Id, X-Offenders-Request-Id, X-Offendersearch-Request-Id). Errors use the offenders.io {code, message} shape.
Combination-validation (400 with {code:400, message}): q cannot be combined with firstName/lastName, nor with lat/lng; address cannot be combined with q, nor with lat/lng.
GIS search (lat+lng supplied): results are paged 50 per page (regular searches page 20), and the query defaults to the last 90 days of source updates (updatedAtStart = now − 90d) unless the caller supplies an explicit updatedAtStart. A missing radius defaults to 1 mile (capped at 100).
Request
- Base URL: https://api.offendersearch.app
- URL: https://api.offendersearch.app/v1/compat/sexoffender
- Auth: one of:
- API key in header X-API-Key
- HTTP bearer
- API key in query parameter key
Headers
Optional client correlation id; echoed back when valid.
Request body
Response
offenders.io-shaped response
Example response
{
"offenders": [
{
"firstName_nicknames": [
"john",
"johnny"
],
"stateData": {
"shoeSize": "10½",
"build": "Large",
"shoeWidth": "D"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.