For Individuals

CrystalRoofCrystalRoof

Flood risk in radius overlay

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

Description

This method returns Crystal Roof’s flood risk map overlays. These overlays are taken directly from our main Flood Risk map.

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

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.
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/flood-risk/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