Xoserve

Xoserve Shipper API

Bundled by Xoserve as the Supply Point Quantities service. Lets gas Shippers view the proposed Formula Year (Billing) Annual Quantity value for a meter point ahead of the late-March notification to the current Shipper, together with meter point and network information. A single GET operation filtered by MPRN, or by postcode combined with optional address detail (house_no, street, town, county, country, sub_building_name, dependent_street, dependent_local). Returns JSON or XML. Available to Gas Shippers only, after contract countersigning.

Documentation GitHub OpenAPI

Documentation

https://discoveryapiportal.correla.com/api-details#api=shipper&operation=getShipper_1

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

Specifications

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

Schemas & Data

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

Other Resources

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

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

https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/skills/xoserve-lookup-supply-point-quantities.md

https://discoveryapiportal.correla.com/

https://discoveryapiportal.correla.com/signin

https://www.xoserve.com/media/7975/xoserve-try-before-you-buy-api-service-subscription-guide.pdf

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

OpenAPI Specification

openapi: 3.0.1
info:
  title: Shipper
  description: The Formula Year AQ is used to calculate the billing rates that will be applied in the coming financial year and by the Shipper/Suppliers to quote customers.The purpose of this API is to enable Shippers to view the proposed Formula Year (Billing) AQ value prior to the notification sent to the current Shipper in late March.
  version: v1
servers:
  - url: https://discoveryapi.correla.com/shipper
paths: { }
components:
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: APIKey
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
security:
  - { }
  - apiKeyHeader: [ ]
  - apiKeyQuery: [ ]