API Documentation

Everything you need to integrate CrimeRisk into your application.

Authentication

All API requests require an API key passed via the X-API-Key header. Get your key from the signup page.

Header

X-API-Key: your_api_key_here

Production

https://api.crimerisk.co.uk

Returns a crime risk score for the given UK postcode. The postcode should be URL-encoded (spaces replaced with %20 or removed).

Parameters

Name	Type	Description
postcode	string (path)	UK postcode, e.g. `SW1A1AA` or `SW1A%201AA`

Request

curl https://api.crimerisk.co.uk/api/risk/SW1A1AA \
  -H "X-API-Key: your_api_key"

200 OK

{
  "postcode": "SW1A 1AA",
  "score": 42,
  "level": "moderate",
  "computedAt": "2025-01-15T00:00:00.000Z"
}

Paid plans include the same fields plus a full crime category breakdown with individual scores.

Response Fields

Field	Type	Description
postcode	string	Normalised postcode
score	number	Risk score (0–100)
level	string	Risk level: low, moderate, high, or very high
computedAt	string	ISO 8601 timestamp of when the score was calculated

Status	Meaning
400	Invalid postcode format
401	Missing or invalid API key
404	Postcode not found in database
429	Monthly request limit exceeded

Error Response Format

{
  "error": "Invalid UK postcode format.",
  "postcode": "INVALID"
}