API reference/Energy & Utilities/Greenest Time to Use Power

Greenest Time to Use Power

proLive data

Lowest-carbon window in the next 48 h for a job of a given length, and the saving vs. starting now.

GET/api/v1/energy/best-time

Data source

Query parameters

ParameterDescriptionTry value
hours
number
Job length in hours, 0.5–12 (default 2)
apikey
string required
Your API key. Can also be sent as the X-API-Key header.demo key used here

Response envelope

Success: { data, meta: { sources, fetchedAt, cached } }. Errors: { error: { code, message } } with HTTP 400, 401, 404, 502, 503 or 504.