Welcome to Xoserve - At the heart of the GB Gas Industry
At the heart of the UK Gas Industry

API Services

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 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 – making a better change of supply experience, increasing 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)
  • Shippers
  • Suppliers
  • Third Party Intermediaries (TPIs)

You need an active Gas API Service account with us to start using the interfaces. Complete an API Services Application form and return it to the Customer Life Cycle Team to get started.

API Services Application Form

Below are the API Banding, each band shows the maximum allowance of API calls (hits) allowed per annum.

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. Please note 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 Life Cycle Team.

 

Supply Point Switching API

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 data are available with this API. You can also view a full list of Supply Point Switching API data items below.

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

  • 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 Address The address for the metering point, provided by the relevant Gas Transporter inc 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 a metering point is located in
    Meter Capacity indicator e.g., 1= up to and including 11 cubic metres, 2= above 11 cubic metres 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 in m3
    Meter Serial Number Identifier for metering equipment at a premises
    Annual Quantity Annual quantity of gas assumed to be off taken 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

 

Supply Point Enquiry API

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 below provides a full breakdown.

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

  • 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 Address The address for the metering point, provided by the relevant Gas Transporter inc House Name, Number Street etc
    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) that the Supply Point resides in
    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
    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 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)
    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 in m3
    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 Number of Dials Number of Dials the Meter has installed on the Supply Point
    Meter Imperial Indicator Indicator if the Meter installed on the Supply Point is Imperial
    AMR Indicator Automated Meter Reading (AMR) Indicator, shows if an AMR device is currently installed
    AMR 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

 

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 below 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 Life Cycle 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 an LDZ
    Network Owner Name Name of the Gas Transporter Organisation where the Supply Point is located
    CSEP ID Unique identifier for the Connected System Exit Point (CSEP) that the Supply Point resides in
    AMR 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.


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 Life Cycle Team.

If you have any operational queries regarding the service, please email the SPA Enquiry Team.

Cookie Policy | Privacy Policy | Terms & Conditions | Company No. 05046877. VAT Registration No. 851 6025 43
© Copyright Xoserve Limited 2018 - All Rights Reserved. Registered Office Lansdowne Gate, 65 New Road, Solihull, B91 3DL. Registered in England and Wales.