Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WattTime Grid Regions API

Discover and query grid balancing authorities and regions.

WattTime Grid Regions API is one of 6 APIs that WattTime publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Grid Regions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 3.0.

Requests are made against 2 base URLs: https://api.watttime.org/v3, https://api2.watttime.org/v2.

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0
Base URL
https://api.watttime.org/v3
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

WattTime Grid Regions API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • basicAuth — HTTP Basic Authentication used only for the /login endpoint. Provide username and password to obtain a bearer token.
  • bearerAuth — JWT bearer token obtained from the /login endpoint. Token expires after 30 minutes. Include as Authorization: Bearer {token} header.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Grid Regions 2

Discover and query grid balancing authorities and regions.

GET
/region-from-loc
WattTime Get Grid Region from Location
getRegionFromLocation 3 params → 200400401404
GET
/maps
WattTime Get Grid Region Boundary Maps
getGridMaps 1 param → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (3 properties), RegionResponse (3 properties), GridMapsResponse (2 properties). Each schema is shown below with its type and property counts.

RegionResponse
object
3 properties
GridMapsResponse
object
GeoJSON FeatureCollection of grid region boundaries.
2 properties
ErrorResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

watttime-grid-regions-api-openapi.yml Raw ↑

Other APIs WattTime publishes across the network.

WattTime Python Client
WattTime Account API
WattTime Authentication API
WattTime Emissions Data API
WattTime Forecasts API