Documentation

Base URL https://api.gridcapacityapi.com/v1. JSON over HTTPS, RFC 3339 timestamps in UTC, one error shape on every route, and an OpenAPI 3.1 document at /v1/openapi.json that needs no key.

$ curl "https://api.gridcapacityapi.com/v1/capacity/nearby?lat=51.5074&lng=-0.1278&radius_km=25" \  -H "Authorization: Bearer gc_live_..."

Paste it into an assistant and it will know the endpoints, the auth scheme and the response shape. Read it first

Read this before you rely on a number

Every record says what the operator’s latest published dataset reports, under which methodology, seen when. Hosting-capacity figures are indicative and reflect what operators publish. They are not a connection offer; only the operator can confirm capacity for a specific request.

Start

QuickstartA key, a first request and a first capacity record, in curl, JavaScript and Python.AuthenticationBearer keys, live and test keys, and which routes answer without one.

The data

The capacity modelEvery field and every enum of a capacity record: direction, availability type, firmness, horizon, units and methodology.Rights and licensingRights modes, why values are withheld rather than hidden, and how to attribute what you use.Freshness and historyThe two clocks, source health, as_of queries and the history of every series.ComparabilityWhy two operators' figures are not automatically comparable, and the strict, best_effort and raw modes.

Using the API

Pagination and sortingCursors, page sizes per plan, and the sort keys each list accepts.ErrorsThe error envelope and every error code, with its status and what to do about it.Rate limits and plansPer-second limits, monthly quotas, the RateLimit headers and what each plan unlocks.

Features

WebhooksChange-feed events pushed to your endpoint, signed, with verification in Node and Python.ExportsWhole-dataset downloads as CSV, JSON Lines or GeoJSON, built asynchronously.Postcode lookupThe areas an operator says serve a postcode, with their current capacity.

Reference

ChangelogWhat changed in the API, newest first.