For Individuals

CrystalRoofCrystalRoof

Broadband availability

UK
gethttps://crystalroof.co.uk/customer-api/internet/broadband-availability/v1/{location}

Description

This method returns broadband availability in the UK including Superfast Broadband (30Mbit/s or greater download speed), Ultrafast Broadband (100Mbit/s or greater download speed), Gigabit Broadband (1000Mbit/s or greater download speed) availability, and download/upload speed.

Pricing

1 credit per 1 request.

Parameters

NameDescription
location
path
string
Postcode, coordinates in the lat,long format or UPRN in the uprn12345678 format.
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/internet/broadband-availability/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