Flood risk
England
Wales
Scotland
gethttps://crystalroof.co.uk/customer-api/environment/flood-risk/v1/{location}
Description
This method provides the flood risk for a given postcode/coordinate/UPRN.
Parameters
Name | Description |
---|---|
location path string | Postcode, coordinates in the lat,long format or UPRN in the uprn12345678 format. Postcode with or without space. This argument is case-insensitive. |
api_key query enum | Your API key.
|
Request URL:
https://crystalroof.co.uk/customer-api/environment/flood-risk/v1/W60WW?api_key=DEMO
Possible responses with examples
Code
Description
200
Success
{
"data": {
"floodRisk": "Very Low"
},
"dataDate": "2023-12",
"refreshedDate": "2024-04"
}
401
Unauthorized
{
"error": "No such API key or it is not valid anymore."
}
402
Payment Required
{
"error": "You have exhausted the available calls provided by your package."
}
403
Forbidden
{
"error": "API key is invalid for the given action."
}
404
Not Found
{
"error": "Can't find such location."
}
429
Too Many Requests
{
"error": "Too many requests have been sent in one second."
}
500
Internal Server Error
{
"error": "We have already started working on a resolution!"
}