Gas Application Programming Interfaces

Our APIs include: Supply Point Switching, Supply Point Enquiry and Supply Point Quantities.

Our APIs give customers access to gas consumer data to improve industry efficiency and drive greater levels of switching.

Download the Gas API Application Form

Powering the Gas Industry with APIs

We are responsible for centrally managing and maintaining gas registration data on behalf of the gas industry in Britain.

To help improve the gas supplier switching experience for consumers, we host a number of Application Programming Interfaces (APIs). Giving access to gas consumer use data, they help our customers improve their business operations and increase efficiency.

Ultimately, our Gas APIs work to improve the supplier switching process. They help to make a better change of supply experience and increase the number of people choosing to switch and how often they move supplier.

Accessing APIs

Gas API Services are available to gas industry customers working to support the improvement in the reliability of switching, and provide an enhanced consumer experience.

Eligible customers include:

  • Price Comparison Websites (PCWs)
  • Third-Party Intermediaries (TPIs)
  • Gas Shippers and Suppliers

You will need an active Gas API Service account with us to take part. Complete an API Services Application form and return it to the Customer Contracts Team to get started.

Available Gas API Services

Supply Point Switching API

To take part in the Switching API, please download and return a completed API Services Application form to the Customer Contracts Team.

The Supply Point Switching API service is available to authorised GB gas industry customers who are working to provide improvements to the supplier switching process.

Meter point data, supplier and network ID and Annual Quantity (AQ) data are available with this API. You can also view a full list of Supply Point Switching API data items.

Data Item Description
Meter Point Reference Number Unique identifier for a supply offtake point. Used to identify the meter to be switched.
Metering Point Address The address for the metering point provided by the relevant Gas Transporter, including House Name/Number, Street etc.
Metering Point Postcode The postcode for the metering point, provided by the relevant Gas Transporter
Current Supplier ID Industry identifier for the current Supplier
Meter Mechanism Code Industry identifier for the type of equipment fitted e.g. credit or prepayment meter
GT ID Unique Identifier for the Gas Transporter Organisation. For large Transporters, this can also be used to identify the geographical area where a metering point is located.
Meter Capacity Indicator e.g. 1= up to and including 11m³, 2= above 11m³

The maximum amount of gas that can be passed through the meter. This is provided for sites connected to a Transporter Network.

The capacity of the metering point is measured in M³.

Meter Serial Number Identifier for metering equipment at a premises.
Annual Quantity Annual quantity of gas assumed to be offtaken over a period based on historical information. Provided in kWh.
Local Distribution Zone This is a discrete gas system supplying gas to a region.
Smart Meter Equipment Technical Code Specification ID of the smart meter

 

Gas API Service Application Form

Download
Supply Point Enquiry API

To take part in the Enquiry API, please complete an API Services Application form and return it to the Customer Contracts Team.

The Supply Point Enquiry API service is available to customers requiring access to technical data. It is for organisations working to improve change of supply and data assurance processes.

The data items available with this API provide meter point information, supply information and technical data for the supply point. Our list of Supply Point Enquiry API data items provides a full breakdown.

Data Item Description
Meter Point Reference Number Unique identifier for a supply offtake point. Used to identify the meter being switched.
Metering Point Postcode The postcode for the metering point, provided by the relevant Gas Transporter.
Network Owner Name Name of the Gas Transporter organisation where the Supply Point is located.
Network Owner Effective From Date Date which the Gas Transporter Owner became effective for the supply point
Local Distribution Zone This is a discrete gas system supplying gas to a region.
CSEP ID Unique identifier for the Connected System Exit Point (CSEP) where the Supply Point is located.
Current Supplier ID Industry Identifier for the current supplier.
Current Supplier Name Name for the current supplier.
Incoming Supplier ID Industry Identifier for the incoming Supplier (if a COS is in progress).
Withdrawal Status Indicates if the supply point is currently withdrawn from the supplier.
Isolation Status Indicates if the supply point is isolated.
Interruption Contract Exists Indicates where an interruption contract exists on a Supply Meter Point.
Meter Point Status Shows the status of the Supply Meter Point
Market Sector Code Shows the Market Sector where the Supply Point resides.
Supply Point Annual Quantity (AQ) Current Supply Meter Point Annual Quantity (AQ) of gas assumed to be off taken over a period. Based on historical information. Provided in kWh.
Supply Point Offtake Quantity Current Supply Meter Point Supply Offtake Quantity (SOQ) of gas assumed to be off taken over a period based on historical information. Provided in kWh.
Supply Point Formula Year Annual Quantity Current Formula Year Supply Meter Point Annual Quantity (AQ).
Supply Point Formula Year Offtake Quantity Current Formula Year Supply Meter Point Supply Offtake Quantity (SOQ).
Twin Stream Indicator Indicates if the Supply Point is a Twin Stream
Meter Serial Number Identifier for metering equipment at a premises.
Meter Capacity The maximum amount of gas that can be passed through the meter. This is provided for sites connected to a Transporter Network. The capacity of the metering point is measure in m³.
Meter Mechanism Code Industry identifier for the type of equipment fitted e.g. credit or prepayment meter.
Meter Type Meter Type
Meter Device Status Current status of the Meter installed on the Supply Point
Meter Imperial Indicator Indicator if the meter installed on the Supply Point is Imperial.
Automated Meter Reading Indicator Automated Meter Reading (AMR) Indicator. Shows if an AMR device is currently installed.
Automated Meter Reading Service Provider Automated Meter Reading (AMR) Service Provider ID
MAM ID Unique Identifier for the Meter Asset Manager (MAM)
SMSO ID Unique Identifier for the Smart Meter System Operator (SMSO)
SMSO Effective Date Smart Meter System Operator (SMSO) Effective Date
DCC Service Flag Data Communications Company (DCC) Service Flag
DCC Service Flag Effective Date Data Communications Company (DCC) Service Flag Effective Date
Installing Supplier ID Unique Identifier for the installing supplier
First SMETS Installation Date First Smart Metering Equipment Technical Specifications (SMETS) Installation Date
IHD Install Status Shows if In Home Display (IHD) is present.
Latest Meter Read Date Latest Meter Read Date
Latest Meter Read Type Latest Meter Read Type
Latest Meter Read Value Latest Meter Read Value

 

Gas API Service Application Form

Download
Supply Point Quantities API

The Supply Point Quantities API service is for industry customers needing quantifiable information from the meter points.

Meter point and network information are in the available data items with this API. The data also gives Proposed Formula Year Quantity values.

The Supply Point Quantity API data items provide a full list.

Complete an API Services Application form and return it to the Customer Lifecycle Team to get started with the Quantities API.

Data Item Description
Meter Point Reference Number Unique identifier for a supply offtake point and used to identify the meter to be switched
Metering Point Postcode The postcode for the metering point, provided by the relevant Gas Transporter
Local Distribution Zone This is a discrete gas system supplying gas to a region
Exit Zone This is a discrete gas system supplying gas to a region with a Local Distribution Zone (LDZ)
Network Owner Name Name of the Gas Transporter Organisation where the Supply Point is located
Connected System Exit Point ID Unique identifier for the Connected System Exit Point (CSEP) that the Supply Point resides in
Automated Meter Reading Indicator Automated Meter Reading (AMR) Indicator, shows if an AMR device is currently installed
Market Sector Code Shows the Market Sector that the Supply Point resides in
Supply Point Annual Quantity Current Supply Meter Point Annual Quantity (AQ) of gas assumed to be off taken over a period based on historical information provided in kWh
Supply Point Offtake Quantity Current Supply Meter Point Supply Offtake Quantity (SOQ) of gas assumed to be off taken over a period based on historical information provided in kWh
Supply Point Formula Year Annual Quantity Current Formula Year Supply Meter Point Annual Quantity (AQ)
Supply Point Formula Year Offtake Quantity Current Formula Year Supply Meter Point Supply Offtake Quantity (SOQ)
Perspective Supply Point Formula Year Annual Quantity Perspective Formula Year Supply Meter Point Annual Quantity (AQ)
Perspective Supply Point Formula Year Offtake Quantity Perspective Formula Year Supply Meter Point Supply Offtake Quantity (SOQ)
Perspective Supply Point Formula Year Effective Date Perspective Formula Year Supply Meter Point Quantity Values Effective Date

 

API Sandbox Trial Service

Our Sandbox API trial service is a free service using test data.

The service gives test environment access to PCWs, TPIs and other industry organisations to trial how our APIs work with their own systems. Using real data taken from the live systems, the Sandbox Trial environment gives
  clear examples of how the full-product performs.

Please complete the Gas API Service Application Form to get started with your testing - stating clearly that you want access to the Sandbox Trial. Once complete, send the form to the Customer Life Cycle Team.

Gas API Service Application Form

Download
 

Supply Point Switching service

Supply Point Enquiry Service

Supply Point Quantities Service

Data

Domestic Domestic and Non-Domestic Domestic and Non-Domestic

Purpose

Switching Events Switching Events and Portfolio View Formula AQ

Eligible

Price Comparison Websites (PWCs)

Third Party Intermediaries (TPIs)

Suppliers

Suppliers Shippers

API Services Application Forms Process

API Services - Order, Check, Sign Contract, Ready to Go!

API Bandings

Each band shows the maximum allowance of API calls (hits) allowed per year.

Band Allowance
A 60,000
B 600,000
C 3,600,000
D 7,200,000
E 12,000,000
F 18,000,000

 

Pricing for the bands will be detailed in the contract, which will be shared once we have received and validated your API Service Application Form.

Each API service will have its own contract and associated pricing.

Not eligible? Find out from us

We are working on extending access to our APIs. If you are interested in taking part but your organisation is not in one of the groups with access, or you are unsure whether you will be eligible, please email the Customer Contracts Team.

Understanding Application Programming Interfaces

APIs provide a set of requirements that control how software programs communicate with each other. An API simply and securely connects:

  • Business processes
  • Services
  • Content

API services let companies exchange data and build consistent experiences for consumers and users moving from one system to another.

Learn More About Gas API Services

If you have questions regarding the commercial arrangements for the gas API service, please email the Customer Contracts Team.

If you have any operational queries regarding the service, please email the Supply Point Administration (SPA) Enquiry Team.

Thank you for your feedback

Xoserve