Crime rate in radius overlay

England
Wales
gethttps://crystalroof.co.uk/customer-api/overlays/crime/v1/{location}

Description

This method returns Crystal Roof’s proprietary crime rate map overlays. These overlays are taken directly from our main Crime Rates map.

The overlays are circular PNG images, available in 1,000, 1,500, or 2,000-meter radii.

You can request overlays showing either total crime rates or crime rates for a specific crime type (controlled by the variant parameter).

About Crystal Roof’s Crime Rates Map

  • Crime rates are calculated for small geographic areas known as Lower Layer Super Output Areas (LSOAs).
  • Rates are calculated per 1,000 residents, using population data from the 2021 Census.
  • Crime levels are grouped into 10 categories using our proprietary algorithm, which balances both the distribution of crime values and the number of areas with similar rates. These categories are not standard deciles.
  • All figures represent annual data (covering the most recent 12 months).
  • The dataset is updated monthly, with a three-month lag between the current date and the most recent available data.

Integration examples

Pricing

  • 1 credit for an overlay within a 1,000-meter radius
  • 2 credits for an overlay within a 1,500-meter radius
  • 3 credits for an overlay within a 2,000-meter radius

Parameters

NameDescription
location
path
string
Postcode, coordinates in the lat,long format or UPRN in the uprn12345678 format.
variant
query
enum
Type of the crime. Default is total.
radius
query
enum
Radius from a postcode/coordinates/UPRN in meters. Only 1000, 1500 or 2000 meters could be specified. Default is 1000 (1 km).
api_key
query
enum

Your API key.

DEMO key allows you to test the method in the W6 0 postcode sector, or in the [[51.492, -0.25], [51.502, -0.225]] rectangle.

Request URL:
https://crystalroof.co.uk/customer-api/overlays/crime/v1/{location}?api_key=DEMO
Possible responses with examples
Code
Description
200
Success
401
Unauthorized
402
Payment Required
403
Forbidden
404
Not Found
429
Too Many Requests
500
Internal Server Error