Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Insights.Api Health Check API
version: '1.0'
description: Provides an endpoint to check the health of the Insights API service.
servers:
- url: https://data.elexon.co.uk/bmrs/api/v1
tags:
- name: Health Check
description: Provides an endpoint to check the health of the Insights API service.
paths:
/health:
get:
tags:
- Health Check
summary: Health check
description: This endpoint provides a success response code (200) with status code 2 if the service is alive
responses:
'200':
description: API is healthy
'429':
description: Too many requests
'503':
description: API is unhealthy or in degraded state
operationId: getHealth
x-operation-id-source: derived
x-provenance:
method: harvested
publisher: Elexon
source: https://data.elexon.co.uk/swagger/v1/swagger.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)