Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gridcertainty.com/llms.txt

Use this file to discover all available pages before exploring further.

Base structure

The public API is organized under one base URL:
https://api.gridcertainty.com
All public routes documented in the API reference live under /v1, except the health route at /health.

Main route groups

Route groupPurpose
/v1/datasetsdiscover datasets and inspect metadata
/v1/datasets/{id}/queryfetch rows from a dataset
/v1/datasets/{id}/auditinspect dataset audit records
/v1/dataset-updates/{id}check update history
/v1/pricing_locationsinspect pricing nodes, hubs, and zones
/v1/reports/...pull report-style outputs
/v1/api_usageinspect plan and usage metadata

Authentication model

Public routes accept API keys in two forms:
  • x-api-key header
  • api_key query parameter
Header-based authentication is the preferred format for production integrations.

Response patterns

Most list and query routes return JSON responses with:
  • data for rows or items
  • meta for pagination details
Some routes also support CSV output through return_format=csv.

How to approach the API

  1. Discover the dataset you want.
  2. Inspect its metadata.
  3. Query it with time filters and selected columns.
  4. Switch to CSV download if you need file export.