Skip to main content
Each entry below corresponds to a date-based version you can pin per Auth Client or per request. See Versioning for how to upgrade.
​
Gauss introduces households, assets with live data and schedules, spot prices, and savings estimates, and moves quotes to a request body. It is in preview, so requests opt in through the X-API-Version header. Older versions keep the removed routes and previous response shapes.Breaking changes
  • Calculate a quote takes its inputs in the request body. The §14a EnWG modules move into one grid_fee_reductions object, and the consumption moves to usage.consumption.
  • The quote response drops meter_type and states the load-shifting discount as its own optimization subcomponent. energy is now the undiscounted day-ahead average.
  • POST /plans/{id}/quote and POST /plans/{id}/savings require a write:* token.
  • On every version, list endpoints return 400 for an unknown filter field or an unsupported operator. See Filtering.
New features
  • GET /households and GET /households/{id} expose the households a customer’s subscriptions belong to.
  • POST /assets, GET /assets, GET /assets/{id}, PATCH /assets/{id}, and POST /assets/{id}/decommission manage the devices behind a household’s meter: inverters, solar, batteries, wallboxes, and heat pumps.
  • POST /asset-snapshots and GET /asset-snapshots send and read the live state of a household’s assets.
  • GET /assets/{id}/schedule reads the quarter-hour plan in force for a steerable asset.
  • GET /spot-prices returns German EPEX day-ahead prices and the Nomos day-ahead price forecast.
  • POST /plans/{id}/savings estimates what a household saves per year on a plan.
  • Calculate a quote accepts an optional optimization_rate and §14a EnWG module 3 (14a_module_3).
  • On every version, subscriptions carry a household field.
  • Invoices add support for exit summaries via a new type value (exit_summary).
  • PATCH /leads/{id} updates a lead’s editable fields and merges metadata key by key.
​
Curie introduces feed-in support, improved smart meter orders, webhook events, the first PATCH endpoints, and restructures key resources around top-level endpoints. Older versions keep the removed routes and previous response shapes.Breaking changesSeveral routes are replaced by top-level endpoints. The old routes are removed from this version onwards:Scope the new list endpoints to a single subscription with filter[subscription][eq]=<id>
  • The Retrieve usage data response object field changes from consumption to usage.
  • Meter order responses collapse status from 14 internal partner-specific states to 8 public values and drop updated_at; see Retrieve a smart meter order for the full list. POST /meter-orders is unchanged.
New features
  • Feed-in plans compensate customers for electricity they feed into the grid, for example from rooftop solar. Plans and subscriptions carry a type field (consumption or feed_in).
  • POST /subscriptions/{id}/terminate terminates a subscription via a discriminated reason field: ORDINARY, MOVE_OUT, or WITHDRAWAL.
  • PATCH /subscriptions/{id} updates the billing address, payment method, or metadata.
  • PATCH /customers/{id} updates the customer’s name.
  • Meter orders report lifecycle timestamps and reasons for cancelled or blocked orders.
  • Invoices add support for prepayments and voided invoices via new type values (prepayment, void) and statuses (voided, uncollectible).
  • Structured validation errors: failures return an errors[] array with one entry per invalid field instead of a single message.
  • Webhook events for invoices and smart meter orders.
​
Edison adds grid fee reductions for §14a EnWG modules, smart meter orders, and filtering on all list endpoints.New features
  • GET /grid-fee-reductions, GET /grid-fee-reductions/{id}, and POST /grid-fee-reductions manage grid fee reductions for §14a EnWG modules.
  • GET /meter-orders, GET /meter-orders/{id}, and POST /meter-orders manage smart meter orders for a subscription.
  • All list endpoints support Filtering.
​
Batman introduces pagination on all list endpoints and API versioning.Breaking changes
  • List endpoints are paginated. See Pagination. Affects /customers, /leads, /plans, /subscriptions, /subscriptions/{id}/invoices, /subscriptions/{id}/meter_readings, /suppliers, and /suppliers/search.
New features
  • Versioning. Routes stay the same; pin a version per Auth Client or per request via X-API-Version.
​
Initial public version of the Nomos API.