offenders.io drop-in compatibility (GET)

Identical semantics to the POST form; parameters are supplied as query string values (offenders.io demo/GET mode). Accepts the key via X-API-Key, Authorization: Bearer, or ?key=.

get/v1/compat/sexoffender

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

Query parameters

firstNamestring
lastNamestring
dobstring date
ageinteger
citystring
statestring
zipcodestring
addressstring
latnumber
lngnumber
radiusnumber
qstring
fuzzyboolean
mode'extensive'
prefixMatch'firstName' | 'lastName' | 'both'
faceIdstring
createdAtStartstring date-time
createdAtEndstring date-time
updatedAtStartstring date-time
updatedAtEndstring date-time
uuidstring
personUuidstring
pageinteger
perPageinteger
keystring

API key (offenders.io demo mode); alternative to the header.

Headers

X-Request-Idstring

Response

offenders.io-shaped response

pageinteger
totalPagesinteger
errorinteger nullable

offenders.io convention: present (e.g. 503) when the result set may be incomplete (deadline-partial or a source errored).

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.