Getting started
API Basic page
Getting Access
Access to this API requires to have an active Inbound Contact service as well as the Call Traffic Controller feature enable. If these pre-requisites are met, then in order to obtain the API credentials necessary to use to this API send…
IMEI Lookup
Product
Retrieves the IMEI for the associated MSISDN.
Overview
An IMEI stands for International Mobile Equipment Identity. Think of it as your phone's fingerprint — it's a 15-digit number unique to each device. We share IMEI numbers to enable tracking of smartphones that may be stolen or compromised
Our…
Terms of use
Basic page
Terms of Use for the BT API Developer Portal Website
1. Terms and conditions and acceptance
1.1. These terms and conditions ("Terms") govern the…
Validate and qualify company
Product Documentation
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…
Cookie policy
Basic page
Our cookie policy
Edit your cookie settings
You can change your cookie settings for the developer.bt.com website through the Manage Cookie Settings page at anytime.
What are cookies and why do we use them?
Cookies and similar technologies (“…
Number portability check
Product Documentation
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.
Product Order (Ethernet)
Product Documentation
Place, modify and track Ethernet orders across Etherway Fibre (EAD), Etherflow Connected, Etherflow Internet and Etherway Superfast GEA (SOGEA & FTTP).
Ethernet
Product
End to End APIs for every step of the Wholesale Ethernet journey.
Ethernet offers a national layer 2 Ethernet service,targeting UK communication providers with bandwidth optionsranging from 0.2Mbps to 10Gbps.
Integrating Ethernet APIs into your business applications increases efficiency and visibility by enabling a truly digital order experience for you and your end customers. These APIs, based on TMF standards, allow you to manage the entire…
Footfall Data
Product
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
Foreign Visitor Data
Product
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
Product Documentation
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
Product
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
Product
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
Product Documentation
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
Product Documentation
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…
Hub Insights Data
Product
Provides data on footfall within and journeys to POI locations. Output data spatial aggregation increases on greater distance from the target area.
Overview
The Hub Insights API provides volumes for daily footfall, 15 minute window footfall, and journeys to and from client provided or standard geographic areas. This allows you to measure the kinds of visitors to a given space, along with the…
Encrypt personally identifying information
Product Documentation
This API product converts a customer’s mobile telephone number (MSISDN) into the secure tokenised Anonymised Mobile Subscriber Reference (AMSR) and vice versa.
CAMARA APIs
Page Builder
CAMARA APIs
Benefits of Camara
Developing and Standardizing APIs:
CAMARA creates APIs that make it easy to…
Complete Mobile order management and notifications
Product Documentation
These APIs allow you to submit and manage Complete Mobile orders. These APIs use OAuth2 for authentication and are based on the TMF622 API.
Address Management (Ethernet)
Product Documentation
Set an address using a UK postcode, or manually create a temporary one, before placing an order.
Appointment Management (Ethernet)
Product Documentation
Users can query for appointment slots based on particular date and book engineer appointment. This is only for standard appointments of Etherway Superfast GEA product.
Order Notification Import Orders (Ethernet)
Product Documentation
Automated notifications on progress of orders placed via the Import Order APIs will be sent directly to the provided URL ('callback URL') provided at onboarding.
Product Qualification (Ethernet)
Product Documentation
Provides a standardized mechanism for placing a qualification request, to check offer eligibility with all of the necessary parameters.
Back to top