Xoserve

Xoserve Supplier API

Bundled by Xoserve as the Supply Point Enquiry service, part of the Gas Enquiry Service (GES). Exposes detailed supply meter point information, filtered by MPRN, address_id or postcode combined with optional address detail. Aimed at organisations working to improve change-of-supply and data assurance processes. Access is arranged through the Retail Energy Code Company (RECCo), not directly with Xoserve.

Documentation GitHub OpenAPI

Documentation

https://discoveryapiportal.correla.com/api-details#api=supplier&operation=getSupplier_1

https://www.xoserve.com/products-services/data-products/gas-apis/

https://www.xoserve.com/products-services/data-products/gas-enquiry-service-ges/

Specifications

https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/openapi/xoserve-supplier-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/json-schema/xoserve-supplier-api-components.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/overlays/xoserve-supplier-api-overlay.yaml

https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/examples/xoserve-supplier-api-response-example.json

https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/skills/xoserve-resolve-supply-point-from-address.md

https://discoveryapiportal.correla.com/

https://discoveryapiportal.correla.com/signin

OpenAPI Specification

openapi: 3.0.1
info:
  title: Supplier
  description: 'The purpose of this API is to expose detailed Supply Meter Point information, enabling subscribers to filter the data by MPRN, Address ID and Address details.'
  version: v1
servers:
  - url: https://discoveryapi.correla.com/supplier
paths: { }
components:
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: APIKey
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
security:
  - { }
  - apiKeyHeader: [ ]
  - apiKeyQuery: [ ]