list utilities
Discover utilities and rate plans without creating a home. A request requires utilityId, zipcode, or both lat and long. Pass utilityId (EIA utility ID) when you already know the utility; use zipcode or lat/long to discover utilities for a location. Response utilityId is that same EIA ID. Send ratePlans[].id as ratePlanId; ratePlans[].udId repeats that WattShift plan ID, while ratePlans[].rateID is the semantic tariff reference (not an EIA ID).
Authorizations
WattShift API key
Headers
WattShift API Key
Body
- Option 1
- Option 2
- Option 3
zipcode for utility
^(?:0{0,4}[0-9]{1,5}|[0-9]{3})(?:[-\s][0-9]{4})?$latitude for utility rates
longitude for utility rates
radius within which utility rates are requested
EIA utility ID (alternative to zipcode). Pass when you already know the utility; use zipcode or lat/long to discover utilities for a location. Not a rate plan id or rateID.
timestamp, seconds since 1970-01-01T00:00:00, UTC
full, minimal Response
Validation failure
"req_123"
AUTH_MISSING_API_KEY, AUTH_INVALID_API_KEY, AUTH_EXPIRED_CREDENTIAL, AUTH_REVOKED_CREDENTIAL, AUTH_INSUFFICIENT_SCOPE, VALIDATION_FAILED, RATE_LIMITED, NOT_FOUND, FORBIDDEN, PRODUCTION_ACCESS_DENIED, INTERNAL_ERROR "VALIDATION_FAILED"
"Request validation failed."
"Provide the x-ws-api-key header. If this contradicts the public docs, submit feedback through /v1/feedback."
3600
