v1

OpenAPI 3.1.02026-07-13252193.7 KB
Comparison

Compare energy products for a month

Simulates every applicable Product Version offered in the requested month for the supplied Supply Point and Consumption Profile, and returns them ranked cheapest-first per energy type. Describe the connection under supplyPoint (location, metering, residential) and the usage under consumption — supply a consumption.electricity and/or consumption.gas object to choose what to compare. applicability narrows to the Product Versions a household can use (before simulation). Call GET /v1/serviceable-locations first to discover valid postal codes/cities and which energy types each supports. See the 422 response for the location and validation errors this can return.

post/v1/comparisons

Request body

yearMonthstring required

Year and month in YYYY-MM format (e.g. 2026-02)

productVersionIdsstring[]

Optional allow-list: restrict the comparison to these specific Product Version ids.

Response

Default Response