Skip to content

Energy demand database

Operations on the energy demand database. Available on the client as client.energy_demand_database.

energy_demand_database.list

async def list() -> list[EnergyDemandDBResponse]

List the specific energy demands of the database.

REST operation: GET /sympheny-app/database-energy-demand-table

Returns: list of EnergyDemandDBResponse

async with AsyncSympheny(username, password) as client:
    entries = await client.energy_demand_database.list()
with Sympheny(username, password) as client:
    entries = client.energy_demand_database.list()

energy_demand_database.calculate

async def calculate(demand_type: DemandType, requests: list[EnergyDemandDBRequest]) -> list[float]

Calculate a demand profile from the database.

REST operation: POST /sympheny-app/database-energy-demand-profile/{demandType}/calculate

Each request needs area_m2 or annual_kwh.

Parameters

Name Type Required Description
demand_type DemandType yes Demand type of the profile.
requests list of EnergyDemandDBRequest yes Request body.

Returns: list of float, the demand profile.

async with AsyncSympheny(username, password) as client:
    profile = await client.energy_demand_database.calculate(DemandType.space_heating, requests)
with Sympheny(username, password) as client:
    profile = client.energy_demand_database.calculate(DemandType.space_heating, requests)