📄️ Overview
The customer API is served under the base path /api/v0/. All authenticated endpoints require the header Authorization: Bearer . See Authentication for how to obtain a token.
📄️ Health check
Simple endpoint to verify the API is running. No authentication required.
📄️ Login
Sign in with your email and password to receive a Bearer token. Use this token in the Authorization header for all other API requests.
📄️ Custom forecast
Returns the latest forecast file(s) for the authenticated customer. Forecasts can have different types (e.g. Forecast, DailyHourly). These types can be agreed beforehand with the user based on their needs. You can request a single type or all types, and get the response as JSON or CSV (or a ZIP when requesting all types as CSV).
📄️ Normalized forecast
Standard forecast endpoint consumed by the portal. Returns the latest normalized forecast file for each plant.
📄️ Plants
Manage generation plants for the authenticated customer. Each plant belongs to the customer tied to the Bearer token. Other customers’ plants are never returned.
📄️ Purchases
Endpoints to submit, update, and retrieve energy purchase strategies.
📄️ List strategies
Returns the list of strategies for a given user and retailer. Used to discover available strategies before submitting purchases.
📄️ Unavailabilities
Record availability intervals per plant (curtailment, unavailability, etc.). All times are stored in UTC. Each row belongs to the authenticated customer; plant_id must match an existing plant name for that account.
📄️ Telemetry upload
Upload generation telemetry as a single CSV file per request. The server writes to S3: