VWvwala
Intake

Estimate a Consumption Profile from an Energy Profile

Changed on

Models a yearly Consumption Profile for the requested energy type(s) — gas, electricity, or both — from a household Energy Profile (family size, heat pump, EVs, solar panels, battery). Used when no measured consumption is available. The response carries one Consumption Profile per requested energy type. familySize is always required; the electricity-only fields are required when energyTypes includes ELECTRICITY.

post/v1/estimations

Request

Request body

energyTypesstring[] required

Which energy types to estimate. One or both of ELECTRICITY, GAS. Each requested type yields a Consumption Profile under the matching key in the response.

familySize'1' | '2' | '3' | '4' | '>5' required

Household size band. Always required (both gas and electricity estimates use it).

hasHeatPumpboolean

Whether the household has a heat pump. Required when energyTypes includes ELECTRICITY; ignored for a gas-only estimate.

evCountinteger

Number of electric vehicles. Required when energyTypes includes ELECTRICITY; ignored for a gas-only estimate.

solarPanelCountinteger

Number of solar panels (0 if none). Required when energyTypes includes ELECTRICITY; ignored for a gas-only estimate.

hasBatteryboolean

Whether the household has a home battery. Required when energyTypes includes ELECTRICITY; ignored for a gas-only estimate.

Response

Default Response

Changes

  • 1673faf11a0fRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

      response property electricity/consumptionDayKwh list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property electricity/consumptionNightKwh list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property electricity/injectionDayKwh list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property electricity/injectionNightKwh list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property electricity/injectionTotalKwh list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property electricity/inverterCapacityKva list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property electricity/peakConsumptionKw list-of-types was narrowed by removing types null from media type application/json of response 200