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.




About APIs

What are APIs, how do they work and what do they do? This brief overview includes some common business scenarios where APIs are useful.

 

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
  • Meter Asset Providers (MAPs)

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 API Enquiries 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
API Enquiries 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.

Supply Point Switching API Technical Specification

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

DMQ

Daily Metered current annual offtake quantity (AQ) of a Supply Meter Point.

Value in kWh

NDMQ

 

Non-Daily Metered current annual offtake quantity (AQ) of a Supply Meter Point.

Value in kWh

 

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 API Enquiries 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.

Supply Point Enquiry API Technical Specification

Data Item

Description

MPRN

Meter Point Reference Number (MRPN).  A unique identifier for the point at which a meter is, has been or will be connected to the Gas Network.

Network Name

Gas Distribution Network Name

Current Supplier Name

Name of the current Supplier for the supply meter point.

Incoming Supplier Code

A unique three character code used to identify the Incoming Supplier.

Supply Point Withdrawal Status

Identifies if the site is not registered to a Shipper or the current Shipper has withdrawn.

Interruption Contract Exists

Indicator to identify whether an Interruption Contract Exists on the supply meter point.

Network Owner Effective from date

Date the network owner is effective from for a supply meter point.

Twin Stream Site Indicator

Indicates if the supply meter point is currently a twin stream site.

CSEP ID

The unique identifier for the Connected System Exit Point (CSEP).

Formula Year Supply Meter point AQ

The supply meter point AQ that is fixed throughout the formula year for determination of Transportation rates. Value in kWh

Supply Meter Point SOQ

The current value for the peak daily supply offtake quantity (SOQ) of a supply point. Value in kWh

Formula Year Supply Meter point SOQ

The current value for SOQ of the supply point that is fixed throughout the formula year for determination of transportation rates. Value in kWh.

Meter Type

The type of meter installed at the supply point.

Meter Device Status

A code indicating the current status of the meter installed at the supply point.

Meter Number of Dials

Number of dials or digits on the meter which are considered during meter reading

Meter Imperial Indicator

Indicator identifying if the meter measures volume of gas consumed in metric or imperial units.

MAM Short Code

A unique three character code used to identify the Meter Asset Manager (MAM)

SMSO ID

The identity of the operator, a Supplier has procured data and communication services from, in respect of a Smart Metering System.

SMS Operating Entity EFD

The date on which the Smart Meter System Operator (SMSO) becomes effective.

DCC Service Flag

Data Communications Company (DCC) Service Flag.

DCC Service Flag EFD

The first inclusive calendar date for which the status of Data Communications Company (DCC) Service Flag applies.

Installing Supplier ID

A unique three character code used to identify the Supplier responsible for the first SMETS Meter Installation at the supply point.

First SMETS installation Date

First Smart Metering Equipment Technical Specifications (SMETS) Installation Date

IHD Install Status

Information from the Supplier regarding the status/existence of the In Home Display (IHD) at a supply point.

AMR Indicator

Automated Meter Reading (AMR) Indicator

Isolation Status

Isolation Status

AMR SP

A unique three character code used to identify the Automated Meter Reading (AMR) Service Provider

Latest Meter Read Date

Latest Meter Read Date

Latest Meter Read Type

Latest Meter Read Type

Latest Meter Read Value

Latest Meter Read Value

Postcode

Postcode

House Number

House Number

House Name

House Name

Sub Building Name

Sub Building Name

Street

Street

Town

Town

County

County

Country

Country

Dependent Street

Dependent Street

Dependent Locality

Dependent Locality

Double Dependent Locality

Double Dependent Locality

PO Box Number

PO Box Number

Delivery Point Alias

Delivery Point Alias

Current Supplier

A unique three character code used to identify the current supplier

Meter Point Status

The current status of the operability of the supply meter point.

Market Sector Code

A code that specifies that the site is used for domestic or industrial and commercial purposes.

IDZ ID

Unique reference code for the Local Distribution Zone (LDZ).

Meter Capacity

The amount of gas that can be passed through the meter in a given time period. This is the manufacturer's maximum value.

Meter Mechanism

The coded value of the description of the Meter Mechanism.

MSN

The manufacturer's meter serial number as held on the physical meter currently installed on the supply point.

MPAQ

The current annual offtake quantity (AQ) of a Supply Meter Point. Value in kWh.

Class

Denotes the current class type for the Supply Meter Point. VALUES: 1 - Class 1, 2 - Class 2, 3 - Class 3, 4 - Class 4

Shipper Short Code

Specifies the 3 digit unique Shipper Short Code for the current Shipper.

End User Category Code

A unique reference for the End User Category assigned to the Supply Point.

Small Large Supply Point Indicator

Indicator showing if a Supply Point is Large (LSP) or Small (SSP) Annual Quantity threshold of 73,200 kWh.

Previous Supplier Name 
(Portfolio View)

Name of the last previous Supplier assigned to the Supply Point.

Previous Supplier Short Code
(Portfolio View)

Specifies the 3 digit unique Supplier Short Code for the previous Supplier.

Confirmation Reference Number
(Portfolio View)

A sequential number that uniquely identifies the Confirmation.

Confirmation Effective Date
(Portfolio View)

Date on which the current Shipper took over responsibility for the Supply Point.

Priority Consumers Indicator
(Portfolio View)

The category of priority consumer at the Supply Meter Point.

Meter Read Batch Frequency
(Portfolio View)

The frequency on which reads will be received for class 3 Supply Meter Points.

CSEP Max Annual Quantity

The total projected maximum annual offtake (AQ) of gas (measured in kWh) of all Supply Meter Points associated with this CSEP’s connection to the upstream network.

Original Supply Meter Point Annual Quantity
(Portfolio View)

The initial estimated Annual Quantity for the Supply Meter Point.

Supply Meter Point Current Year Minimum Annual Quantity
(Portfolio View)

The minimum bookable annual capacity based on the historic maximum annual offtake for a Supply.

CSEP Supply Point Offtake Quantity

The daily offtake (SOQ) of gas (measured in kWh) of all Supply Points associated with the CSEP’s connection to the upstream network, calculated from the EUC AQ and DM SOQ information.

Meter Manufacturer
(Portfolio View)

Identifies the Short code of meter manufacturer of the meter installed at the Supply Point.

Meter Model
(Portfolio View)

The model description of the meter installed at the Supply Point.

Meter Year of Manufacture
(Portfolio View)

The year in which the meter installed at the Supply Point was manufactured expressed as a century date (e.g. 1981).

Meter Installation Date
(Portfolio View)

Date the meter was installed at the Supply Point.

Meter Units
(Portfolio View)

This contains the units the meter installed on a Supply Point is reading in e.g. 10, 100, 1000.

Meter Location
(Portfolio View)

A code representing the location of a meter installed at the Supply Point.

Correction Factor
(Portfolio View)

This is a fixed factor where no convertor is fitted and the meter reading needs to be corrected for Pressure/Altitude/Temperature. Format: 999.999999.

Gas Act Owner

Unique code which identifies the role the market participant is acting in.

Meter Asset Manager Effective Date
(Portfolio View)

The date on which Meter Asset Manager (MAM) is effectively responsible for the meter assets at the Supply Point.

Shipper Name

Name of the current Shipper assigned to the Supply Point

IGT Transportation Charge Rate

The monetary rate that is applicable to the Supply Meter Point for IGT transportation charges.

IGT Transportation Charge Rate Type

Indicator showing the type of IGT Transportation Charge Rate being applied.

IGT Charging Methodology

The IGT charging methodology that is applied to the Supply Point.

End User Category (EUC) Identifier

A unique reference for the End User Category assigned to the Supply Point.

Daily Metered/Non Daily Metered Indicator

Indicator showing if the Supply Meter Point is Daily Metered Values: Daily Metered, Non Daily Metered.

Meter Link Code

A code specifying the functional relationship between meters at given locations on an End User's site.

Convertor Indicator

Indicator for the presence of a Converter Asset.

Address ID

Unique identifier for the address.

Supply Meter Point SHQ

Current Supply Meter Point SHQ (Standard Hourly Offtake Quantity).

UPRN

Unique identifier for every addressable location in Great Britain.

SMP Prospective Formula Year AQ

Prospective Formula Year AQ value. 'Prospective' is a synonym for 'Perspective'.

SMP Prospective Formula Year SOQ

Prospective Formula Year SOQ value. 'Prospective' is a synonym for 'Perspective'.

SMP Prospective Formula Year Effective Date

Prospective Formula Year effective date. 'Prospective' is a synonym for 'Perspective'.

Exit Zone

Exit Zone code.

 

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 API Enquiries Team to get started with the Quantities API.

Supply Point Quantities API Technical Specification

Data Item

Description

Meter Point Reference Number

Unique identifier for a supply offtake point and used to identify the meter to be switched

Automated Meter Reading Indicator

Automated Meter Reading (AMR) Indicator, shows if an AMR device is currently installed

Address Data

Including the following:

·      Country

·      County

·      Dependent Local

·      Dependent Street

·      House no

·      Street

·      Sub Building Name

·      Town

·       Installation Number

·       Postcode

Connected System Exit Point ID

Unique identifier for the Connected System Exit Point (CSEP) that the Supply Point resides in

Current AQ Roll Value

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 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)

Current SOQ Roll Value

Current Supply Meter Point Standard Offtake Quantity (AQ) of gas assumed to be off taken over a period based on historical information provided in kWh

Distribution Network Operator

Name of the Gas Transporter Organisation where the Supply Point is located

Exit Zone

This is a discrete gas system supplying gas to a region with a Local Distribution Zone (LDZ)

Local Distribution Zone

This is a discrete gas system supplying gas to a region

Market Sector Code

Shows the Market Sector that the Supply Point resides in

Perspective Supply Point Formula Year Annual Quantity

Perspective Formula Year Supply Meter Point Annual Quantity (AQ)

Perspective Supply Point Formula Year Effective Date

Perspective Formula Year Supply Meter Point Quantity Values Effective Date

Perspective Supply Point Formula Year Offtake Quantity

Perspective Formula Year Supply Meter Point Supply Offtake Quantity (SOQ)

 

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
Meter Asset Enquiry API

• To take part in the Enquiry API, please complete an API Services Application form and return it to the API Enquiries Team.
• The Meter Asset Enquiry API service is available to customers requiring access to meter asset data. It is for organisations working to improve data assurance processes.
• Our list of Meter Asset Enquiry API data items provides a full breakdown.

Meter Asset Enquiry API Technical Specification

Data Item

Description

Meter Point Reference Number
(MPRN)

Meter Point Reference Number (MRPN). A unique identifier for the point at which a meter is, has been or will be connected to the Gas Network.

Meter Serial Number
(MSN)

The manufacturer's meter serial number as held on the physical meter currently installed on the supply point

Current Supplier ID

A unique three character code used to identify the current supplier

Supplier Name

Name of the current Supplier

Meter Capacity

The amount of gas that can be passed through the meter in a given time period. This is the manufacturer's maximum value

Meter Mechanism Code

The coded value of the description of the Meter Mechanism

Meter Type

The type of meter installed at the supply point

Meter Model

Model of meter installed at the supply Point

Meter Year of Manufacture

The year of Manufacture of the meter installed at the supply point

Meter Installation Date

The date of when the meter was installed

Service Effective Valid From

The date of when the service becomes effective for the Supply Point

Meter Asset Manager ID

An identification number for the registered MAM for the Supply Point

Meter Asset Manager Name

The company name of the registered MAM for the Supply Point

Meter Asset Manager Effective Date

The date of when the MAM became effective for the Supply Point

Meter Asset Provider ID

A placeholder for the MAP ID data item; it should appear as blank in the API.
It will be populated with actual MAP ID data once MAP ID is added to UK Link in late 2020

 

Supply Point Switching Service

Supply Point Enquiry Service

Supply Point Quantities Service

Meter Asset Enquiry Service

Data

Domestic Domestic and Non-Domestic Domestic and Non-Domestic

Domestic and Non-Domestic

Purpose

Switching Events Switching Events and Portfolio View Formula AQ

Meter Asset data assurance

Eligible

Price Comparison Websites (PCWs)

Third Party Intermediaries (TPIs)

Suppliers

Suppliers

Shippers

Shippers

Meter Asset Providers (MAPs)

API Services Application Forms Process

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

Once You Have Access

 

Xoserve Try Before You Buy API Service Subscription Guide

Last updated on 12 Aug 2020

Xoserve Live API Service Subscription Guide

Last updated on 12 Aug 2020

Xoserve API Testing Guide

Last updated on 21 Jan 2020

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 you’re not sure you’ll be eligible, get in contact with our API Enquiries Team, who’ll be happy to help.

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 any questions regarding Gas API commercial arrangements or operational services please contact the API Enquiries Team.

Thank you for your feedback