Frequently Asked Question
Broadband - Check Broadband Availability at a given postcode
Last Updated 7 days ago
BroadbandLookup API
Overview
The BroadbandLookup API provides information about broadband coverage for a given postcode, UPRN (Unique Property Reference Number), or address line.
Version
1.001
Endpoint
/v2/bblookup.php
Authentication
This API requires authentication using an API key. The key should be passed in the HTTP_X_API_KEY header.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| p | string | Postcode (required, max 8 characters) |
| u | integer | UPRN (optional) |
| a | string | Address line (optional, max 30 characters) |
Response
The API returns a JSON object with the following structure:
| Field | Type | Description |
|---|---|---|
| status | string | The status of the request. "ok" for successful requests, or an error message. |
| coverage | object or array | Broadband coverage information. Present if status is "ok". |
Example Response
{
"status": "ok",
"coverage": {
// Coverage details here
}
}
Error Handling
- If the postcode is not provided:
{"status": "No postcode provided"} - If the UPRN is not found:
{"status": "No UPRN [uprn] found at this postcode"} - If the address is not found:
{"status": "No Address [address] found at this postcode"} - If no coverage is found:
{"status": "No coverage found for this postcode"} - If there's an error in the OFCOM API response:
{"status": "Invalid JSON response"} - If there's a cURL error:
{"status": "Lookup Error"}
Notes
- The API removes spaces from the provided postcode before processing.
Security
- Ensure that the API key is kept secure and not exposed in client-side code.
- All responses are sent with the "Content-Type: application/json" header.
