APIs and documentation

Three 3G Network Coverage API

Introduction 

This API is used to check H3g UK Network 3G data coverage information using postcode.

H3g UK Network - 3G Data Coverage API

This API is used to check H3g UK Network 3G data coverage information using postcode.

Charges

This API is free for everyone, all you need to have is an account with aql®. Please contact us or fill in our free trial form to obtain an account.

Connection Details

The 3 coverage API is available via our HTTP POST interface: 

https://gw.aql.com/three/data_coverage.api.php (or http) 

Although we do offer the standard HTTP gateway, we do prefer that your application uses the HTTPS gateway as it prevents sensitive details being “sniffed” across the internet.

Gateway Parameters

The gateway expects the following parameters:

Parameter NameRequiredDescription
usernameYesYour aql username
passwordYesYour aql password
postcodeYesThe postcode to lookup. In a whitespace-less format, eg: LS101JQ

Gateway Return Values

On success, the gateway will return the following parameters

Parameter NameValue Description
status200
descOK
postcodeFormatted postcode from the query parameter by removing all whitespace characters.
congestionCongestion band category. Possible values:
Blue: no congestion area.
Green: insignificant congestion area.
Amber: congested area.
Red: heavily congested area.
indoor_typeIndicate if an area has a good indoor/outdoor coverage. Possible values:
out-and-indoor: coverage available outdoor and indoor
outdoor-only: coverage is available outdoor only.

The default format of the retuned data is: 

<status>: <description>. <postcode>: <congestion> - <indoor_type> 

where the items in angle brackets will be replaced with their actual values. 

If the return-mode or return-format parameters are set in the original request, the returned string will be different depending on the format you choose.

Gateway Error Values

If the call was not successful, the gateway will return the following parameters

Parameter NameValue Description
statusStatus code for the type of error (see Below)
descA string with a short description of the error

The format of the retuned data is:

<status>: <desc> 

where the items in brackets will be replaced with their actual values. 

If the return-mode parameter is set to 'url', the format of the returned data will be different. See below for details. 

Status Codes

StatusDescription
200OK
401Authentication error
6200Invalid postcode parameter
6201No coverage data available

Note: *status code 6201 means 3UK 3G Data coverage databases do not contain any information on this particular postcode. 

You can view the return-mode and return-format descriptions here.


Back to Documentation and APIs

Follow us on Twitter

Like us on Facebook

Connect to us on LinkedIn

Where we are

aql
13-15 Hunslet Road
Leeds
LS10 1JQ
Telephone 01133 20 30 40