MobileCoverage API

Overview

The MobileCoverage API provides information about mobile network coverage for a given UK postcode. It can also return specific coverage details for a particular UPRN (Unique Property Reference Number) within that postcode area.

Version

1.000

Endpoint

/v2/molookup.php

Authentication

This API requires authentication using an API key. The key should be passed in the HTTP_X_API_KEY header.

Request Parameters

Response

The API returns a JSON object with the following structure:

Example Response (Success)

{
  "status": "ok",
  "coverage": [
    {
      "UPRN": "123456789",
      "Address": "1 High Street",
      "Postcode": "AB12 3CD",
        "EEVoiceOutdoor": 4,
        "EEVoiceOutdoorNo4g": 4,
        "EEVoiceIndoor": 3,
        "EEVoiceIndoorNo4g": 3,
        "EEDataOutdoor": 4,
        "EEDataOutdoorNo4g": 0,
        "EEDataIndoor": 3,
        "EEDataIndoorNo4g": 0,
        "H3VoiceOutdoor": 4,
        "H3VoiceOutdoorNo4g": 4,
        "H3VoiceIndoor": 3,
        "H3VoiceIndoorNo4g": 0,
        "H3DataOutdoor": 4,
        "H3DataOutdoorNo4g": 3,
        "H3DataIndoor": 3,
        "H3DataIndoorNo4g": 0,
        "TFVoiceOutdoor": 4,
        "TFVoiceOutdoorNo4g": 4,
        "TFVoiceIndoor": 4,
        "TFVoiceIndoorNo4g": 4,
        "TFDataOutdoor": 4,
        "TFDataOutdoorNo4g": 3,
        "TFDataIndoor": 3,
        "TFDataIndoorNo4g": 3,
        "VOVoiceOutdoor": 4,
        "VOVoiceOutdoorNo4g": 4,
        "VOVoiceIndoor": 4,
        "VOVoiceIndoorNo4g": 3,
        "VODataOutdoor": 4,
        "VODataOutdoorNo4g": 0,
        "VODataIndoor": 4,
        "VODataIndoorNo4g": 0    

    },
    // More properties if UPRN not specified
  ]
}

Example Response (Error)

{
  "status": "No postcode provided"
}

Error Handling

• If no postcode is provided: {"status": "No postcode provided"}
• If the postcode has no coverage data: {"status": "No coverage found for this postcode"}
• If a UPRN is provided but not found: {"status": "No UPRN found at this postcode"}
• If there's an error in the upstream APIs lookup: {"status": "Lookup Error"}
• If there's an invalid JSON response: {"status": "Invalid JSON response"}
• If there's an authentication error: {"status": "[validation status]"}

Notes

• The API uses the mobile carrier data to generate the coverage information.
• If a UPRN is provided, the API will return coverage information specific to that property.
• If no UPRN is provided, the API returns coverage information for all properties in the postcode.
• The numbers returned indicate
  • 0 = None (you should not expect coverage)
  • 3 = Limited (coverage may be limited)
  • 4 = Likely (you are likely to have coverage)

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.

Limitations

• Coverage data is limited to UK postcodes.