Ofcom Connected Nations Broadband API
API change historyAn API based on Connected Nations broadband data.
Get broadband provision by postcode
This endpoint will return predicted broadband speeds broken down by up/down and by Basic/Superfast/Ultrafast alongside percentage availability of the broadband speed categories.
Try itRequest
Request URL
Request parameters
-
string
The postcode of interest
Request headers
Request body
Responses
200 OK
Successful operation - broadband provision is returned
Representations
{
"PostCode": "string",
"Availability": [
{
"UPRN": 0,
"AddressShortDescription": "string",
"PostCode": "string",
"MaxBbPredictedDown": 0.0,
"MaxBbPredictedUp": 0.0,
"MaxSfbbPredictedDown": 0.0,
"MaxSfbbPredictedUp": 0.0,
"MaxUfbbPredictedDown": 0.0,
"MaxUfbbPredictedUp": 0.0,
"MaxPredictedDown": 0.0,
"MaxPredictedUp": 0.0
}
]
}{
"title": "FixedAvailability",
"type": "object",
"properties": {
"PostCode": {
"description": "Postcode of address, spaces removed",
"type": "string",
"maxLength": 7
},
"Availability": {
"type": "array",
"items": {
"title": "BroadbandProvision",
"type": "object",
"properties": {
"UPRN": {
"description": "Unique Property Reference Number",
"type": "integer",
"format": "int32"
},
"AddressShortDescription": {
"description": "A compiled address description based on use of the Ordnance Survey AddressBase fields of the form - Building Name, Building Number, Dependent_ThoroughFare",
"type": "string"
},
"PostCode": {
"description": "Postcode of address, spaces removed",
"type": "string",
"maxLength": 7
},
"MaxBbPredictedDown": {
"type": "number",
"minimum": -1,
"format": "double"
},
"MaxBbPredictedUp": {
"type": "number",
"minimum": -1,
"format": "double"
},
"MaxSfbbPredictedDown": {
"type": "number",
"minimum": -1,
"format": "double"
},
"MaxSfbbPredictedUp": {
"type": "number",
"minimum": -1,
"format": "double"
},
"MaxUfbbPredictedDown": {
"type": "number",
"minimum": -1,
"format": "double"
},
"MaxUfbbPredictedUp": {
"type": "number",
"minimum": -1,
"format": "double"
},
"MaxPredictedDown": {
"type": "number",
"minimum": -1,
"format": "double"
},
"MaxPredictedUp": {
"type": "number",
"minimum": -1,
"format": "double"
}
},
"required": [
"UPRN",
"AddressShortDescription",
"PostCode"
]
}
}
},
"required": [
"PostCode",
"Availability"
]
}404 Not Found
Post Code not found
Representations
{
"PostCode": "string",
"ErrorMessage": "string"
}{
"title": "FixedAvailabilityNotFound",
"type": "object",
"properties": {
"PostCode": {
"description": "Postcode of address, spaces removed",
"type": "string",
"maxLength": 7
},
"ErrorMessage": {
"description": "A human readable error message",
"type": "string"
}
},
"required": [
"PostCode",
"ErrorMessage"
]
}500 Internal Server Error
General error
Representations
{
"ErrorMessage": "string"
}{
"title": "GeneralError",
"type": "object",
"properties": {
"ErrorMessage": {
"description": "A human readable error message",
"type": "string"
}
},
"required": [
"ErrorMessage"
]
}Code samples
@ECHO OFF
curl -v -X GET "https://api-proxy.ofcom.org.uk/broadband/coverage/{PostCode}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://api-proxy.ofcom.org.uk/broadband/coverage/{PostCode}?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api-proxy.ofcom.org.uk/broadband/coverage/{PostCode}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://api-proxy.ofcom.org.uk/broadband/coverage/{PostCode}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api-proxy.ofcom.org.uk/broadband/coverage/{PostCode}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api-proxy.ofcom.org.uk/broadband/coverage/{PostCode}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api-proxy.ofcom.org.uk')
conn.request("GET", "/broadband/coverage/{PostCode}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api-proxy.ofcom.org.uk')
conn.request("GET", "/broadband/coverage/{PostCode}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api-proxy.ofcom.org.uk/broadband/coverage/{PostCode}')
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body