List UK Police Reference Data
ukcrime_list_referenceDecode the vocabulary the other ukcrime tools take: police force ids, crime category slugs, a force's neighbourhood ids, and data availability — the published months, and which forces published stop and search in each. Use it when a force, category, neighbourhood id or month is unknown; name_contains filters forces and neighbourhoods by name. The Metropolitan Police has about 680 neighbourhoods, so filter by name there; to get the force and neighbourhood covering a latitude and longitude, call ukcrime_find_neighbourhood instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Force id such as 'leicestershire', or its name such as 'Leicestershire Police'; case-insensitive, spaces, underscores and hyphens match each other, '&' matches 'and', and a trailing 'Police', 'Police Service' or 'Constabulary' is optional. Required for topic 'neighbourhoods'. On 'availability', where 'btp' (British Transport Police) is also accepted, adds the months this force did and did not publish stop and search. Not accepted on 'forces' or 'categories'. | |
| month | No | Month as YYYY-MM. Topic 'availability' only: return just that month's row. | |
| topic | Yes | What to list: 'forces' (force ids), 'categories' (crime category slugs), 'availability' (published months and stop-and-search publication), or 'neighbourhoods' (one force's neighbourhood ids; needs force). | |
| name_contains | No | Words that must all appear in the name, in any order — case, accents and punctuation ignored, so the value needs at least one letter or digit. Topics 'forces' and 'neighbourhoods' only. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when the call failed. Absent on success. | |
| force | No | Topic 'neighbourhoods': the force whose neighbourhoods are listed. | |
| topic | No | The topic listed; its list field below is the one present. | |
| forces | No | Topic 'forces': the forces data.police.uk lists, plus British Transport Police ('btp'), which ukcrime_search_stops takes with area 'force' and ukcrime_search_crimes with area 'force_unplaced'. | |
| notice | No | Why a list is empty — a name filter that matched nothing, or a month that is not published — and what to do instead. | |
| categories | No | Topic 'categories': every crime category. | |
| attribution | No | Open Government Licence attribution for data.police.uk data. | |
| availability | No | Topic 'availability': the published-month window and stop-and-search publication by month. | |
| neighbourhoods | No | Topic 'neighbourhoods': the force's neighbourhoods, sorted by name. |