Why can’t I see API products in the production environment when building an app?
API products in the production environment are only visible in the app creation process to developers who have the appropriate authorization. If you can’t see a product that you think that you should have access to, please contact your account manager.
How do I use the API key and secret to call an API?
Most of our external APIs are authenticated with an OAuth token which is generated using the OAuth API. To produce the authorisation string for the OAuth request, the app's client ID, ':' and password are concatenated and base64-encoded. This string is…
How much does it cost to use this site?
Using the developer portal and sandbox APIs is free of charge. Access to live APIs in our production environment are subject to contractual agreement which will specify the commercial terms for API usage.
How are APIs billed / paid for?
Where APIs are chargeable, they are billed under a billing agreement that forms part of our overall commercial contract. Please contact your account manager for more information.
What is the difference between sandbox and production APIs?
Our sandbox APIs emulate the live environment and give you the opportunity to send test API calls and to receive a simulated response. The production APIs work with our live systems and data.
Do our APIs work with other mobile operators?
Our APIs are designed to work with BT brands only, these include EE, BT and Plusnet. Some APIs support information for MVNOs on our mobile network. Not all of our brands are supported by all APIs – please check the relevant API documentation.
What types of services do your APIs provide?
Our APIs provide a wide range of services relating to both our company’s products and managing interactions with our customers.
How do I find out my quota limits for the production environment?
Depending on how you propose to use our APIs, we may enforce a quota for usage in production. This will be agreed as part of our commercial contract.
How do I access live data?
Live data is only available to organisations with an appropriate contractual agreement. Please contact our account management teams via ‘Contact us’ for further details.
How do I get help with a fault or issue?
Please try to resolve your issue by reading articles in the Knowledge Centre. If you can't find a solution, please use the form in the ‘Contact us’ section.
Why is my app approval status showing as “Pending”?
Apps in the production environment give access to live systems or live data and may require approval / configuration before going live. Please contact you account manager if you are concerned about any delay with your app.
Are there any quota limits on the sandbox environment?
We reserve the right to put limits on the volume of calls made to our sandbox and we believe that customers will be able to create and test their apps in the sandbox without hitting any usage limits.
Validate and qualify company
Use this API to validate key data before placing an order on WHC/WHC Express.This will prevent order submission failures. Validate the required unique fields, 'Company Name & Company Domain', are not already in use before generating a unique service…
Number portability check
Check whether a particular number range (for WHC Express you can only port a particular number not number range) can be ported based on portState value in response. Enter a number to verify if this is capable of being ported.
Inbound Contact Global Traffic Controller
Apply changes in real-time to your Inbound Contact Global service Inbound Contact Global Call Traffic Controller API creates an entirely new method to manage, rebalance and reroute call traffic in real time. Choose from a range of access numbers, egress methods and routing logic. The Controller API is the natural…
Provides data on overall footfall in the UK Overview The Footfall API provides volumes for overall footfall, footfall density, mobility (time spent in or away home area location) and visits (footfall excluding population observed in home location) for the UK population
Provides volumes for overall footfall, footfall density, mobility (time spent in or away home area location) and visits (footfall excluding population observed in home location) for the UK population. This API will return a signed URL used to access a CSV…
Foreign Visitor Data
Provides data on footfall of foreign visitors in UK Overview This API provides volumes for the overall footfall of foreign visitors to the UK by country of origin, foreign visitors footfall locations, foreign visitors footfall based on their activity on the first day of arrival and foreign visitors…
Foreign Visitor API
Provides volumes for the overall footfall of foreign visitors to the UK by country of origin, foreign visitors footfall locations, foreign visitors footfall based on their activity on the first day of arrival and foreign visitors footfall based on their…
UK Traveller Data
Provides data on international journeys of UK roamers Overview The UK Traveller Data API provides volumes of international journeys, journey returns and stay durations made by UK roamers as a cross-border origin-destination report with a trip origin abroad and a destination within the UK for UK nationals.…
UK Trips Data
Provides data on UK-wide origin-destination matrix Overview The UK Trips Data API provides volumes of Middle Layer Super Output areas (MSOA) level origin destination trip connections at monthly and daily level for the UK population.
UK Trips API
Provides volumes of MSOA level origin destination trip connections at monthly and daily level for the UK population, API returns signed URL to access UK trips CSV file containing the data, time expiry for signed URL is 15 seconds. When data doesn't exist…
UK Travellers API
Provides volumes of international journeys, journey returns and stay durations made by UK roamers as a cross-border origin-destination report with a trip origin abroad and a destination within the UK for UK nationals. Data is provided by international…
Activate the port and progress HV SingleLine/MultiLine Order.
Set an address using a UK postcode, or manually create a temporary one, before placing an order for either a Number Port or WHC/WHC Express order. Enter a postcode to return a full valid UK address, using BT's NAD system (synced with Royal Mail PAF) or…