Search US sex-offender registries and criminal records, with per-source citations.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Run many person/location lookups in one call (row-in / row-out). Each row goes through the SAME engine as search_offenders, so a row's records are identical to what a single search would return. A row that fails is reported with status='error' in place and never aborts the batch. Max 1000 rows. Returns: { count, results: [ { index, status, counts{records,sourcesQueried, sourcesIncomplete}, warnings: [str], records: [Record], error? } ] } in input order. ★ A row with `counts.sourcesIncomplete > 0` could not be searched to the end — its `records` are a LOWER BOUND, not a clean 'no match'. Auth: uses the caller's X-API-Key (request header or OFFENDERSEARCH_API_KEY env).
List of query objects (max 1000). Each may set any of: firstName, lastName, dob (YYYY-MM-DD), age, city, state, zipcode, address, lat, lng, radiusMiles, q. One row in = one result out, in input order.
Fuzzy tolerance applied to every row (see search_offenders).
Request extensive detail (offenses[], stateData, images) for every row.
Cache/pricing tier applied to every row: daily=<=24h (default), weekly=<=7d.
Registry codes applied to EVERY row (e.g. ['FL','TX']). Omit = all 58 registries.
Apply per-state scoping to every row (see search_offenders).
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Run many person/location lookups in one call (row-in / row-out). Each row goes through the SAME engine as search_offenders, so a row's records are identical to what a single search would return. A row that fails is reported with status='error' in place and never aborts the batch. Max 1000 rows. Returns: { count, results: [ { index, status, counts{records,sourcesQueried, sourcesIncomplete}, warnings: [str], records: [Record], error? } ] } in input order. ★ A row with `counts.sourcesIncomplete > 0` could not be searched to the end — its `records` are a LOWER BOUND, not a clean 'no match'. Auth: uses the caller's X-API-Key (request header or OFFENDERSEARCH_API_KEY env).
| Argument | Type | Description |
|---|---|---|
| match | string | Fuzzy tolerance applied to every row (see search_offenders). |
| queries* | array | List of query objects (max 1000). Each may set any of: firstName, lastName, dob (YYYY-MM-DD), age, city, state, zipcode, address, lat, lng, radiusMiles, q. One row in = one result out, in input order. |
| extensive | boolean | Request extensive detail (offenses[], stateData, images) for every row. |
| freshness | string | Cache/pricing tier applied to every row: daily=<=24h (default), weekly=<=7d. |
| jurisdictions | any | Registry codes applied to EVERY row (e.g. ['FL','TX']). Omit = all 58 registries. |
| location_scoped | boolean | Apply per-state scoping to every row (see search_offenders). |
{
"type": "object",
"title": "batch_searchArguments",
"required": [
"queries"
],
"properties": {
"match": {
"enum": [
"strict",
"balanced",
"broad"
],
"type": "string",
"title": "Match",
"default": "balanced",
"description": "Fuzzy tolerance applied to every row (see search_offenders)."
},
"queries": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"title": "Queries",
"description": "List of query objects (max 1000). Each may set any of: firstName, lastName, dob (YYYY-MM-DD), age, city, state, zipcode, address, lat, lng, radiusMiles, q. One row in = one result out, in input order."
},
"extensive": {
"type": "boolean",
"title": "Extensive",
"default": false,
"description": "Request extensive detail (offenses[], stateData, images) for every row."
},
"freshness": {
"enum": [
"daily",
"weekly"
],
"type": "string",
"title": "Freshness",
"default": "daily",
"description": "Cache/pricing tier applied to every row: daily=<=24h (default), weekly=<=7d."
},
"jurisdictions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Jurisdictions",
"default": null,
"description": "Registry codes applied to EVERY row (e.g. ['FL','TX']). Omit = all 58 registries."
},
"location_scoped": {
"type": "boolean",
"title": "Location Scoped",
"default": false,
"description": "Apply per-state scoping to every row (see search_offenders)."
}
}
}List the criminal-record jurisdictions searched, with kind and status. Use it to discover which states and counties are reachable and which are answering today, before relying on an empty result. Depth is uneven by design: counties publish independently, so a state with many county jurisdictions is not "better covered" than one that publishes a single statewide source — it is differently structured. Returns the jurisdiction roster; each entry carries its code, the state it belongs to, the kind of records it holds (jail / prison / court / warrant / registry) and whether it is currently answering.
No arguments.
{
"type": "object",
"title": "get_criminal_coverageArguments",
"properties": {}
}List every registry we cover plus its scope, legal status, and health. Public coverage catalog (no API key required). Use it to discover the `jurisdictions` codes accepted by search_offenders / batch_search and to check per-registry freshness/health before relying on a result. Returns: { count, registries: [ SourceInfo ] } where each SourceInfo is: - id: registry code (e.g. 'IL', 'TX', 'PR') - name: human-readable registry name - covers: [state codes] a registry covers ('*' = national / all) - scope: 'state' | 'national' - status: 'live' | 'building' - legal: { commercialUse: 'allowed'|'restricted'|'prohibited'|'unknown' } - health: { lastSuccessAt, typicalLatencyMs, ageSeconds, freshFor } `health` is OPERATIONAL COVERAGE METADATA about our ingest schedule, published for transparency. It is NOT a quality warning about a search result: a search serves every registry's best available data regardless of `freshFor`, so a registry listing only 'weekly' still contributes its records to a freshness='daily' search. Do NOT tell a user their search results are stale, unreliable or out of date on the basis of these fields — they are not. The only completeness signal that belongs in an answer is `counts.sourcesIncomplete` / `warnings[]` from the search response itself.
No arguments.
{
"type": "object",
"title": "get_registry_coverageArguments",
"properties": {}
}Get what to draw inside a drawn shape: a polygon, or a line with a buffer. The same answer as map_viewport for the shape's bounding box, limited to what is inside the shape, at the same detail levels (clusters, pins, or named pins at zoom 15+). The response adds `shape: 'polygon' | 'route'`. Returns: { shape, mode, zoom, bbox, datasetVersion, total, breakdown {street, housed, homeless, incarcerated}, clusters[], markers[], areas[], unplaced {count, states}, notice }. - 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. Never describe them as being at an exact spot. - 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 shape holds. Marker and group ids work for 24 hours. The Map API must be turned on for the account (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).
| Argument | Type | Description |
|---|---|---|
| zoom | any | Optional map zoom, 0 to 22. Decides the detail as on map_viewport: 3-12 clusters, 13-14 pins without names, 15+ pins with names. Omit it and the zoom is worked out from the size of the shape. |
| detail | string | full = clusters or pins (default); count = numbers only. |
| housing | any | Keep only people with one of these housing statuses. |
| polygon | any | A ring of 3 to 200 [lng, lat] points (GeoJSON order: longitude first), e.g. [[-83.0,39.9],[-82.9,39.9],[-82.95,40.0]]. A repeated closing point is fine. Send this OR route_points, not both. |
List the people behind a many-people pin or an approximate-area pin. Returns: { total, page, perPage, totalPages, kind: 'address' | 'area', named, members: [ { id, addressType, label, housingStatus, hasPhoto } ] }. Members carry `label` only when the group id came from a view at zoom 15 or closer (`named: true`). Each member `id` opens with map_open_record. Billing: one map request per page. A group id works for 24 hours and only for the account it was issued to; after that, call map_viewport again. Auth: uses the caller's X-API-Key (request header or OFFENDERSEARCH_API_KEY env).
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. |
| group_id* | string | A `groupId` ('mg_...') from a map_viewport, map_area or map_route marker with `id: null`, from a map_route `groups` entry, or from an entry in `areas` / `approximate.areas`. |
| per_page | integer | People per page, 1 to 100. |
{
"type": "object",
"title": "map_groupArguments",
"required": [
"group_id"
],
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1,
"minimum": 1,
"description": "Page number, starting at 1."
},
"group_id": {
"type": "string",
"title": "Group Id",
"description": "A `groupId` ('mg_...') from a map_viewport, map_area or map_route marker with `id: null`, from a map_route `groups` entry, or from an entry in `areas` / `approximate.areas`."
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 50,
"maximum": 100,
"minimum": 1,
"description": "People per page, 1 to 100."
}
}
}Open the complete record behind one map marker, or behind a saved reference. Returns: { record, recordRef, billing: { billed, unit, reason }, notice }. `record` is the same Record object search_offenders returns. `recordRef` ('mr_...') is a lasting reference: keep it to open the same record later, after the marker id has expired. Billing: one record open per person per map response, at the account's record-open rate (published price $0.035 per open; an account's agreed rate may differ) — so open a marker only when the user wants that person's record, not every marker in a view or along a route. - The same marker id again is free (`reason: 'marker_already_opened'`). - A new map_viewport, map_area, map_route or map_group answer carries new ids; opening the same person from it is a new charge. - Opening by `recordRef` is one record open, then free for 24 hours. A record just opened from a marker is also free by its reference for 24 hours. `billing.billed` says whether THIS open was charged. Marker ids work for 24 hours (410 `marker_expired` after that). A 410 `record_no_longer_listed` means the registry no longer lists the person; it is not billed. Auth: uses the caller's X-API-Key (request header or OFFENDERSEARCH_API_KEY env).
| Argument | Type | Description |
|---|---|---|
| marker_id* | string | A marker id ('mk_...') from map_viewport, map_area, map_route or map_group, or a saved record reference ('mr_...') from an earlier map_open_record. |
{
"type": "object",
"title": "map_open_recordArguments",
"required": [
"marker_id"
],
"properties": {
"marker_id": {
"type": "string",
"title": "Marker Id",
"description": "A marker id ('mk_...') from map_viewport, map_area, map_route or map_group, or a saved record reference ('mr_...') from an earlier map_open_record."
}
}
}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).
| Argument |
|---|
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).
| Argument | Type | Description |
|---|---|---|
| lat | any | Latitude of the centre, instead of bbox (send with lng and radius_miles). |
Search US criminal records — county jail bookings, state prison custody, court cases and warrants. Covers county jail rosters, statewide prison systems, court sources, warrant systems and statewide registries across the states, DC and the territories, plus the federal layer — which is a separate system holding offences no state search will surface. A surname is REQUIRED. Supply firstName and a DOB or birth year wherever you have them: a bare common surname returns thousands of people, and the scoring cannot tell you which one is yours. Each record carries `recordType`, and YOU MUST READ IT BEFORE CHARACTERISING ANYONE: - a jail booking is an ARREST-stage record — charges at booking are frequently reduced, dismissed, or never filed. It is NOT a conviction. - prison custody implies a sentence, and therefore a conviction. - a court record carries the DISPOSITION — the authoritative statement of how a case actually ended. - a warrant means the person is SOUGHT. Nothing has been tested. Never describe someone as convicted on the strength of a booking record. Records also carry: name, aliases, dob/birthYear/dobPrecision, sex, race, state, county, custody status and facility, sentence and parole detail, `cases`, `sources` (per-source citation), and `matchConfidence`/`matchBasis` explaining why it matched. `counts.records` is the total found and `counts.recordsReturned` the number in this page. Not a consumer report: results must not be used for FCRA-covered decisions (employment, tenancy, credit) without appropriate process.
| Argument | Type | Description |
|---|---|---|
| age | any | Approximate current age, when neither DOB nor birth year is known. |
| dob | any | Date of birth, YYYY-MM-DD. The single strongest disambiguator. |
| limit | any | Max records to return. Default 50. |
Search US sex-offender registries for one person and/or location. Fans out across all 58 registries (or the ones named in `jurisdictions`), de-duplicates people across registries, scores each match, and returns the normalized records. Supply whatever identifiers you have — all args are optional but at least a name, location, or free-text `q` should be given. Returns a SearchResponse object (docs/openapi.yaml / FIELD-DICTIONARY.md): - status: 'complete' | 'partial' (partial = a source errored, or a source could not be searched to completion) - counts: { records, sourcesQueried, sourcesIncomplete } - warnings: [str] — ALWAYS present, `[]` when the search ran clean - sourceStatus: [ { source, status, matched, fromCache, note, incomplete, incompleteReason } ] per-registry outcome ★ READ `counts.sourcesIncomplete` BEFORE REPORTING A RESULT. Above 0, `records` is a LOWER BOUND: those registries could not be searched to the end, and an empty or short result is NOT evidence that a person is unregistered. Say so. `warnings[0]` states it in plain language; relay it rather than summarising it away. - records: [ Record ], each with: recordId, matchConfidence, matchBasis[], name {first, middle, last, suffix, full}, aliases[], nicknames[], dob, dobPrecision, age, sex, race, ethnicity, height, weight, eyeColor, hairColor, marks, addresses[{type,line1,city,county,state,zipcode,lat,lng}], offense {crime,statute,riskLevel,tier,convictionDate,...}, flags{absconder,predator}, source {jurisdiction,registryName,recordUrl,scrapedAt,sourceUpdatedAt}, sources[], dobVerification, unverified (offenses[], stateData, images[] are populated only when extensive=true) Auth: uses the caller's X-API-Key (request header or OFFENDERSEARCH_API_KEY env).
| Argument | Type | Description |
|---|---|---|
| q | any | Free-text search across name/alias/address/city/state/zip (all tokens must appear). |
| age | any | Age filter, used when DOB is unknown. Matched +/-1 year for birthday drift. |
| sandbox | boolean | If true, answer in test mode: made-up people (labels start with 'Sample') in the real response shape. Needs no plan and is never billed. |
| street_only | boolean | If true, keep only people with an exact street address. |
| buffer_miles | any | Distance either side of route_points, in miles, 0.05 to 5. |
| route_points | any | A line of 2 to 200 [lng, lat] points (GeoJSON order). Everyone within buffer_miles either side of it is counted. Send with buffer_miles, instead of polygon. For exact per-leg and per-stop counts along a walking or bus route use map_route. |
{
"type": "object",
"title": "map_areaArguments",
"properties": {
"zoom": {
"anyOf": [
{
"type": "number",
"maximum": 22,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Zoom",
"default": null,
"description": "Optional map zoom, 0 to 22. Decides the detail as on map_viewport: 3-12 clusters, 13-14 pins without names, 15+ pins with names. Omit it and the zoom is worked out from the size of the shape."
},
"detail": {
"enum": [
"full",
"count"
],
"type": "string",
"title": "Detail",
"default": "full",
"description": "full = clusters or pins (default); count = numbers only."
},
"housing": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"housed",
"homeless",
"incarcerated"
],
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Housing",
"default": null,
"description": "Keep only people with one of these housing statuses."
},
"polygon": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
},
{
"type": "null"
}
],
"title": "Polygon",
"default": null,
"description": "A ring of 3 to 200 [lng, lat] points (GeoJSON order: longitude first), e.g. [[-83.0,39.9],[-82.9,39.9],[-82.95,40.0]]. A repeated closing point is fine. Send this OR route_points, not both."
},
"sandbox": {
"type": "boolean",
"title": "Sandbox",
"default": false,
"description": "If true, answer in test mode: made-up people (labels start with 'Sample') in the real response shape. Needs no plan and is never billed."
},
"street_only": {
"type": "boolean",
"title": "Street Only",
"default": false,
"description": "If true, keep only people with an exact street address."
},
"buffer_miles": {
"anyOf": [
{
"type": "number",
"maximum": 5,
"minimum": 0.05
},
{
"type": "null"
}
],
"title": "Buffer Miles",
"default": null,
"description": "Distance either side of route_points, in miles, 0.05 to 5."
},
"route_points": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
},
{
"type": "null"
}
],
"title": "Route Points",
"default": null,
"description": "A line of 2 to 200 [lng, lat] points (GeoJSON order). Everyone within buffer_miles either side of it is counted. Send with buffer_miles, instead of polygon. For exact per-leg and per-stop counts along a walking or bus route use map_route."
}
}
}| Type |
|---|
| Description |
|---|
| path | any | The route line: a GeoJSON LineString {'type':'LineString','coordinates':[[lng,lat],...]} (or a Feature holding one), or a plain list [[lng, lat], ...] in GeoJSON order. Send at most one of path or polyline. |
| stops | any | Stops along the route, in order: [{'id':'s1','lng':...,'lat':...}, ...] or [[lng, lat], ...]. Ids default to s1, s2, .... With no path or polyline, 2+ stops are joined by straight lines. Walk: up to 50 stops; bus: up to 150. |
| detail | string | full = counts plus nameless pins (default); count = counts only, same price, never refused for too many pins. |
| housing | any | Keep only people with one of these housing statuses. |
| measure | any | What to count: the corridor either side of the line, a radius around each stop, or both. Default: both when stop_radius_feet is sent, otherwise corridor (stops when there is no line and fewer than 2 stops). |
| profile | any | walk (default; up to 15 miles, stop radius 500 ft) or bus (up to 60 miles, stop radius 1,000 ft). |
| sandbox | boolean | If true, answer in test mode: made-up people in the real response shape. Needs no plan and is never billed. |
| polyline | any | The route line as an encoded polyline (Google = precision 5; Mapbox/OSRM/Valhalla = precision 6), instead of path. |
| external_id | any | Your own reference for this route (up to 100 characters), echoed back as `externalId`. |
| street_only | boolean | If true, keep only people with an exact street address. |
| corridor_miles | any | Corridor width either side of the line, in miles, 0.02 to 0.25 (default 0.1). |
| stop_radius_feet | any | Radius around each stop, in feet, 100 to 2,640 (default walk 500, bus 1,000). |
| polyline_precision | any | Precision of `polyline`: 5 (Google, the default) or 6 (Mapbox/OSRM/Valhalla). |
| parcel_allowance_feet | any | Feet added to the stop radius, 0 to 500, to allow for the distance between a geocoded point and the property line. |
{
"type": "object",
"title": "map_routeArguments",
"properties": {
"path": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
},
{
"type": "null"
}
],
"title": "Path",
"default": null,
"description": "The route line: a GeoJSON LineString {'type':'LineString','coordinates':[[lng,lat],...]} (or a Feature holding one), or a plain list [[lng, lat], ...] in GeoJSON order. Send at most one of path or polyline."
},
"stops": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {
"type": "number"
}
}
]
}
},
{
"type": "null"
}
],
"title": "Stops",
"default": null,
"description": "Stops along the route, in order: [{'id':'s1','lng':...,'lat':...}, ...] or [[lng, lat], ...]. Ids default to s1, s2, .... With no path or polyline, 2+ stops are joined by straight lines. Walk: up to 50 stops; bus: up to 150."
},
"detail": {
"enum": [
"full",
"count"
],
"type": "string",
"title": "Detail",
"default": "full",
"description": "full = counts plus nameless pins (default); count = counts only, same price, never refused for too many pins."
},
"housing": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"housed",
"homeless",
"incarcerated"
],
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Housing",
"default": null,
"description": "Keep only people with one of these housing statuses."
},
"measure": {
"anyOf": [
{
"enum": [
"corridor",
"stops",
"both"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Measure",
"default": null,
"description": "What to count: the corridor either side of the line, a radius around each stop, or both. Default: both when stop_radius_feet is sent, otherwise corridor (stops when there is no line and fewer than 2 stops)."
},
"profile": {
"anyOf": [
{
"enum": [
"walk",
"bus"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Profile",
"default": null,
"description": "walk (default; up to 15 miles, stop radius 500 ft) or bus (up to 60 miles, stop radius 1,000 ft)."
},
"sandbox": {
"type": "boolean",
"title": "Sandbox",
"default": false,
"description": "If true, answer in test mode: made-up people in the real response shape. Needs no plan and is never billed."
},
"polyline": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Polyline",
"default": null,
"description": "The route line as an encoded polyline (Google = precision 5; Mapbox/OSRM/Valhalla = precision 6), instead of path."
},
"external_id": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "External Id",
"default": null,
"description": "Your own reference for this route (up to 100 characters), echoed back as `externalId`."
},
"street_only": {
"type": "boolean",
"title": "Street Only",
"default": false,
"description": "If true, keep only people with an exact street address."
},
"corridor_miles": {
"anyOf": [
{
"type": "number",
"maximum": 0.25,
"minimum": 0.02
},
{
"type": "null"
}
],
"title": "Corridor Miles",
"default": null,
"description": "Corridor width either side of the line, in miles, 0.02 to 0.25 (default 0.1)."
},
"stop_radius_feet": {
"anyOf": [
{
"type": "number",
"maximum": 2640,
"minimum": 100
},
{
"type": "null"
}
],
"title": "Stop Radius Feet",
"default": null,
"description": "Radius around each stop, in feet, 100 to 2,640 (default walk 500, bus 1,000)."
},
"polyline_precision": {
"anyOf": [
{
"enum": [
5,
6
],
"type": "integer"
},
{
"type": "null"
}
],
"title": "Polyline Precision",
"default": null,
"description": "Precision of `polyline`: 5 (Google, the default) or 6 (Mapbox/OSRM/Valhalla)."
},
"parcel_allowance_feet": {
"anyOf": [
{
"type": "number",
"maximum": 500,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Parcel Allowance Feet",
"default": null,
"description": "Feet added to the stop radius, 0 to 500, to allow for the distance between a geocoded point and the property line."
}
}
}| lng |
| any |
| Longitude of the centre, instead of bbox (send with lat and radius_miles). |
| bbox | any | The view as 'west,south,east,north' in degrees, e.g. '-83.5,39.6,-82.4,40.3'. Any size. Send this OR lat/lng with radius_miles, not both. |
| zoom | any | Optional map zoom, 0 to 22. Decides the detail: 3-12 clusters, 13-14 pins without names, 15+ pins with names. Omit it and the zoom is worked out from the size of the view. |
| detail | string | full = clusters or pins (default); count = numbers only. |
| housing | any | Keep only people with one of these housing statuses. |
| sandbox | boolean | If true, answer in test mode: made-up people (labels start with 'Sample') in the real response shape. Needs no plan and is never billed. |
| street_only | boolean | If true, keep only people with an exact street address. |
| radius_miles | any | Radius in miles around lat/lng, 0.1 to 100. |
{
"type": "object",
"title": "map_viewportArguments",
"properties": {
"lat": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Lat",
"default": null,
"description": "Latitude of the centre, instead of bbox (send with lng and radius_miles)."
},
"lng": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Lng",
"default": null,
"description": "Longitude of the centre, instead of bbox (send with lat and radius_miles)."
},
"bbox": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Bbox",
"default": null,
"description": "The view as 'west,south,east,north' in degrees, e.g. '-83.5,39.6,-82.4,40.3'. Any size. Send this OR lat/lng with radius_miles, not both."
},
"zoom": {
"anyOf": [
{
"type": "number",
"maximum": 22,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Zoom",
"default": null,
"description": "Optional map zoom, 0 to 22. Decides the detail: 3-12 clusters, 13-14 pins without names, 15+ pins with names. Omit it and the zoom is worked out from the size of the view."
},
"detail": {
"enum": [
"full",
"count"
],
"type": "string",
"title": "Detail",
"default": "full",
"description": "full = clusters or pins (default); count = numbers only."
},
"housing": {
"anyOf": [
{
"type": "array",
"items": {
"enum": [
"housed",
"homeless",
"incarcerated"
],
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Housing",
"default": null,
"description": "Keep only people with one of these housing statuses."
},
"sandbox": {
"type": "boolean",
"title": "Sandbox",
"default": false,
"description": "If true, answer in test mode: made-up people (labels start with 'Sample') in the real response shape. Needs no plan and is never billed."
},
"street_only": {
"type": "boolean",
"title": "Street Only",
"default": false,
"description": "If true, keep only people with an exact street address."
},
"radius_miles": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 0.1
},
{
"type": "null"
}
],
"title": "Radius Miles",
"default": null,
"description": "Radius in miles around lat/lng, 0.1 to 100."
}
}
}| state |
| any |
| 2-letter state code (e.g. 'TX'). Narrows to that state's jurisdictions. |
| county | any | County name, to narrow within a state. |
| lastName* | string | REQUIRED surname. The criminal corpus refuses an unbounded query — a name is the field that cannot be enumerated. |
| birthYear | any | Birth year alone, when a full DOB is unknown. |
| firstName | any | Given name. Strongly recommended: a bare common surname returns thousands. |
{
"type": "object",
"title": "search_criminalArguments",
"required": [
"lastName"
],
"properties": {
"age": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Age",
"default": null,
"description": "Approximate current age, when neither DOB nor birth year is known."
},
"dob": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dob",
"default": null,
"description": "Date of birth, YYYY-MM-DD. The single strongest disambiguator."
},
"limit": {
"anyOf": [
{
"type": "integer",
"maximum": 200,
"minimum": 1
},
{
"type": "null"
}
],
"title": "Limit",
"default": null,
"description": "Max records to return. Default 50."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"default": null,
"description": "2-letter state code (e.g. 'TX'). Narrows to that state's jurisdictions."
},
"county": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "County",
"default": null,
"description": "County name, to narrow within a state."
},
"lastName": {
"type": "string",
"title": "Lastname",
"description": "REQUIRED surname. The criminal corpus refuses an unbounded query — a name is the field that cannot be enumerated."
},
"birthYear": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Birthyear",
"default": null,
"description": "Birth year alone, when a full DOB is unknown."
},
"firstName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Firstname",
"default": null,
"description": "Given name. Strongly recommended: a bare common surname returns thousands."
}
}
}| dob | any | Date of birth 'YYYY-MM-DD'. Improves match precision; drives dobVerification (dob_match / year_match). |
| lat | any | Latitude for a GIS radius search (pair with lng). |
| lng | any | Longitude for a GIS radius search (pair with lat). |
| city | any | Residence city filter. |
| match | string | Fuzzy tolerance: strict=exact; balanced=nicknames/variants/initials/typos on first name, exact last; broad=also prefix/typo on last name. |
| state | any | 2-letter state/territory code (e.g. 'IL', 'PR'), or the full name. A residence FILTER — it does NOT change which registries run; all 58 are still searched. It filters as a UNION: a record is kept when it has an address in that state OR that state's registry is the one holding it. Each record carries `registrationState` and `addressStates` so you can tell which half matched; for the registration half alone, pass `jurisdictions` instead. |
| address | any | Fuzzy street-address filter (every token must appear in some record address). |
| zipcode | any | Residence ZIP (first 5 digits used). |
| extensive | boolean | If true, request extensive detail (retains offenses[], stateData, images). A light call drops them. |
| freshness | string | Cache/pricing tier: daily=<=24h (default), weekly=<=7d. |
| last_name | any | Surname — the primary match key, e.g. 'Smith'. |
| first_name | any | Given name, e.g. 'John'. |
| deadline_ms | integer | Max time to wait, in ms (default 120000 / 2 min). Lower for a faster bounded response; partial results return status='partial'. |
| radius_miles | any | GIS radius in miles around lat/lng. Defaults to 1 when a point is given; capped at 100. |
| jurisdictions | any | Registry codes to query (e.g. ['IL','TX']). Omit/null = ALL 58 registries. See get_registry_coverage for codes. |
| location_scoped | boolean | OPT-IN ONLY, and never inferred from `state`. If true AND a state is set, run only the registries covering that state instead of all 58. It is a cost knob that COSTS RECALL: anyone registered by another state's registry while residing in the requested state is excluded (7.0% of records). The response reports counts.sourcesSkippedByScope and a NARROWED SEARCH warning when it applies. Leave it false unless the caller explicitly wants the cheaper, narrower search. |
{
"type": "object",
"title": "search_offendersArguments",
"properties": {
"q": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Q",
"default": null,
"description": "Free-text search across name/alias/address/city/state/zip (all tokens must appear)."
},
"age": {
"anyOf": [
{
"type": "integer",
"maximum": 130,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Age",
"default": null,
"description": "Age filter, used when DOB is unknown. Matched +/-1 year for birthday drift."
},
"dob": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dob",
"default": null,
"description": "Date of birth 'YYYY-MM-DD'. Improves match precision; drives dobVerification (dob_match / year_match)."
},
"lat": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Lat",
"default": null,
"description": "Latitude for a GIS radius search (pair with lng)."
},
"lng": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Lng",
"default": null,
"description": "Longitude for a GIS radius search (pair with lat)."
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City",
"default": null,
"description": "Residence city filter."
},
"match": {
"enum": [
"strict",
"balanced",
"broad"
],
"type": "string",
"title": "Match",
"default": "balanced",
"description": "Fuzzy tolerance: strict=exact; balanced=nicknames/variants/initials/typos on first name, exact last; broad=also prefix/typo on last name."
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"default": null,
"description": "2-letter state/territory code (e.g. 'IL', 'PR'), or the full name. A residence FILTER — it does NOT change which registries run; all 58 are still searched. It filters as a UNION: a record is kept when it has an address in that state OR that state's registry is the one holding it. Each record carries `registrationState` and `addressStates` so you can tell which half matched; for the registration half alone, pass `jurisdictions` instead."
},
"address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Address",
"default": null,
"description": "Fuzzy street-address filter (every token must appear in some record address)."
},
"zipcode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Zipcode",
"default": null,
"description": "Residence ZIP (first 5 digits used)."
},
"extensive": {
"type": "boolean",
"title": "Extensive",
"default": false,
"description": "If true, request extensive detail (retains offenses[], stateData, images). A light call drops them."
},
"freshness": {
"enum": [
"daily",
"weekly"
],
"type": "string",
"title": "Freshness",
"default": "daily",
"description": "Cache/pricing tier: daily=<=24h (default), weekly=<=7d."
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Name",
"default": null,
"description": "Surname — the primary match key, e.g. 'Smith'."
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "First Name",
"default": null,
"description": "Given name, e.g. 'John'."
},
"deadline_ms": {
"type": "integer",
"title": "Deadline Ms",
"default": 120000,
"description": "Max time to wait, in ms (default 120000 / 2 min). Lower for a faster bounded response; partial results return status='partial'.",
"exclusiveMinimum": 0
},
"radius_miles": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Radius Miles",
"default": null,
"description": "GIS radius in miles around lat/lng. Defaults to 1 when a point is given; capped at 100."
},
"jurisdictions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Jurisdictions",
"default": null,
"description": "Registry codes to query (e.g. ['IL','TX']). Omit/null = ALL 58 registries. See get_registry_coverage for codes."
},
"location_scoped": {
"type": "boolean",
"title": "Location Scoped",
"default": false,
"description": "OPT-IN ONLY, and never inferred from `state`. If true AND a state is set, run only the registries covering that state instead of all 58. It is a cost knob that COSTS RECALL: anyone registered by another state's registry while residing in the requested state is excluded (7.0% of records). The response reports counts.sourcesSkippedByScope and a NARROWED SEARCH warning when it applies. Leave it false unless the caller explicitly wants the cheaper, narrower search."
}
}
}