GuidesAPI ReferenceChangelogDiscussions
Log In
Guides

Batteries

Battery endpoints expose home storage inventory, latest charge state, and on-demand charge/discharge forecasts for an address.

Base path: /api/v2/addresses/:address_uuid/batteries
Permission: READ_BATTERY_DATA

What we provide

MethodPathPurpose
GET/List batteries for the address
GET/:battery_uuidGet one battery
GET/:battery_uuid/forecast/strategiesList supported forecast strategies
GET/:battery_uuid/forecastCompute forecasts for a time range using default pricing
POST/:battery_uuid/forecastCompute forecasts with optional custom prices and strategy filters

Inventory and charge state

Typical battery payload includes:

  • Identity (identifier)
  • Brand, model, site name
  • Installation date
  • lastChargeState:
    • time
    • status
    • batteryCapacity (Wh)
    • batteryLevel (%)
    • chargeRate (W)
  • Created / updated timestamps

Forecasts

Forecast routes compute charge/discharge plans for [fromDate, toDate).

Behaviour you can rely on:

  • Query dates may include a timezone offset; response timestamps use UTC (+00:00).
  • GET uses platform default day-ahead prices.
  • POST accepts an optional body to supply custom electricity prices and optionally filter strategies.
  • Forecast computation requires a recent battery charge state (updated within the last 60 minutes).
  • Strategy list endpoint returns the optimization strategies your client may request.

Guidance

  • Poll charge state for operational dashboards; treat time as freshness.
  • Call forecast strategies first if your UI needs to present available options.
  • Keep forecast windows bounded; this is a compute-heavy class of endpoint.
  • If forecast calls fail due to stale charge state, refresh/wait for a newer state before retrying.
  • Use custom-price POST only when your commercial logic supplies trusted price series.

Updated about 7 hours ago

Did this page help you?