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.

GitHub OpenAPI

Documentation

📖
APIReference
https://discoveryapiportal.correla.com/api-details#api=shipper&operation=getShipper_1
📖
Documentation
https://www.xoserve.com/products-services/data-products/gas-apis/

Specifications

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

Schemas & Data

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

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/overlays/xoserve-shipper-api-overlay.yaml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/examples/xoserve-shipper-api-response-example.json
🔗
AgentSkill
https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/skills/xoserve-lookup-supply-point-quantities.md
🔗
Portal
https://discoveryapiportal.correla.com/
🔗
SignUp
https://discoveryapiportal.correla.com/signin
🔗
Pricing
https://www.xoserve.com/media/7975/xoserve-try-before-you-buy-api-service-subscription-guide.pdf
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/xoserve/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/xoserve-shipper-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

xoserve-shipper-api-openapi.yml Raw ↑ 
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: [ ]