Ofcom Connected Nations Mobile API

API change history

An API based on Connected Nations Mobile data.

Get mobile provision by postcode

This endpoint will return Clear/Red/Amber/Green ratings for EE/H3/TF/VO mobile providers broken down by Voice/Data and Indoor/Outdoor

Try it

Request

Request URL

Request parameters

  • string

    The postcode of interest

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Successful operation - mobile provision is returned

Representations

[
  {
    "PostCode": "string",
    "Availability": [
      {
        "UPRN": 0,
        "AddressShortDescription": "string",
        "PostCode": "string",
        "EEVoiceOutdoor": "C",
        "EEVoiceOutdoorNo4g": "C",
        "EEVoiceIndoor": "C",
        "EEVoiceIndoorNo4g": "C",
        "EEDataOutdoor": "C",
        "EEDataOutdoorNo4g": "C",
        "EEDataIndoor": "C",
        "EEDataIndoorNo4g": "C",
        "H3VoiceOutdoor": "C",
        "H3VoiceOutdoorNo4g": "C",
        "H3VoiceIndoor": "C",
        "H3VoiceIndoorNo4g": "C",
        "H3DataOutdoor": "C",
        "H3DataOutdoorNo4g": "C",
        "H3DataIndoor": "C",
        "H3DataIndoorNo4g": "C",
        "TFVoiceOutdoor": "C",
        "TFVoiceOutdoorNo4g": "C",
        "TFVoiceIndoor": "C",
        "TFVoiceIndoorNo4g": "C",
        "TFDataOutdoor": "C",
        "TFDataOutdoorNo4g": "C",
        "TFDataIndoor": "C",
        "TFDataIndoorNo4g": "C",
        "VOVoiceOutdoor": "C",
        "VOVoiceOutdoorNo4g": "C",
        "VOVoiceIndoor": "C",
        "VOVoiceIndoorNo4g": "C",
        "VODataOutdoor": "C",
        "VODataOutdoorNo4g": "C",
        "VODataIndoor": "C",
        "VODataIndoorNo4g": "C"
      }
    ]
  }
]
{
  "type": "array",
  "items": {
    "title": "MobileAvailability",
    "type": "object",
    "properties": {
      "PostCode": {
        "description": "Postcode of address, spaces removed",
        "type": "string",
        "maxLength": 7
      },
      "Availability": {
        "type": "array",
        "items": {
          "title": "MobileProvision",
          "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
            },
            "EEVoiceOutdoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "EEVoiceOutdoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "EEVoiceIndoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "EEVoiceIndoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "EEDataOutdoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "EEDataOutdoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "EEDataIndoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "EEDataIndoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "H3VoiceOutdoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "H3VoiceOutdoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "H3VoiceIndoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "H3VoiceIndoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "H3DataOutdoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "H3DataOutdoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "H3DataIndoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "H3DataIndoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "TFVoiceOutdoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "TFVoiceOutdoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "TFVoiceIndoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "TFVoiceIndoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "TFDataOutdoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "TFDataOutdoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "TFDataIndoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "TFDataIndoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "VOVoiceOutdoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "VOVoiceOutdoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "VOVoiceIndoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "VOVoiceIndoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "VODataOutdoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "VODataOutdoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "VODataIndoor": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            },
            "VODataIndoorNo4g": {
              "title": "MobileCoverageValue",
              "description": "States:\n * `C` - Clear\n * `R` - Red\n * `A` - Amber\n * `G` - Green",
              "example": "C",
              "type": "string",
              "enum": [
                "C",
                "R",
                "A",
                "G"
              ]
            }
          },
          "required": [
            "UPRN",
            "AddressShortDescription",
            "PostCode",
            "EEVoiceOutdoor",
            "EEVoiceOutdoorNo4g",
            "EEVoiceIndoor",
            "EEVoiceIndoorNo4g",
            "EEDataOutdoor",
            "EEDataOutdoorNo4g",
            "EEDataIndoor",
            "EEDataIndoorNo4g",
            "H3VoiceOutdoor",
            "H3VoiceOutdoorNo4g",
            "H3VoiceIndoor",
            "H3VoiceIndoorNo4g",
            "H3DataOutdoor",
            "H3DataOutdoorNo4g",
            "H3DataIndoor",
            "H3DataIndoorNo4g",
            "TFVoiceOutdoor",
            "TFVoiceOutdoorNo4g",
            "TFVoiceIndoor",
            "TFVoiceIndoorNo4g",
            "TFDataOutdoor",
            "TFDataOutdoorNo4g",
            "TFDataIndoor",
            "TFDataIndoorNo4g",
            "VOVoiceOutdoor",
            "VOVoiceOutdoorNo4g",
            "VOVoiceIndoor",
            "VOVoiceIndoorNo4g",
            "VODataOutdoor",
            "VODataOutdoorNo4g",
            "VODataIndoor",
            "VODataIndoorNo4g"
          ]
        }
      }
    },
    "required": [
      "PostCode",
      "Availability"
    ]
  }
}

404 Not Found

Post Code not found

Representations

{
  "PostCode": "string",
  "ErrorMessage": "string"
}
{
  "title": "MobileAvailabilityNotFound",
  "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/mobile/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/mobile/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/mobile/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/mobile/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/mobile/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/mobile/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", "/mobile/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", "/mobile/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/mobile/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