A building's energy use

One call gives a building's electricity, heating, water and other use per month, with the data quality of each number.

See Energy data for what EOS is and the rules behind these numbers.

RequestCopy Anchor Link

const { buildings } = await relynk('/consumption.buildings/v1', {
	buildingIds: [buildingId],
	from: '2026-01-01',
	to: '2027-01-01',
	bucket: 'month'
});

What you get backCopy Anchor Link

Each buildings[0].carriers[i] holds carrier, unit, and per month consumption, cost and confidence, plus a total with consumption, confidence, cost and costCoverage.

• These are the building totals as the Relynk portal's EOS dashboard shows them.
• Show each carrier on its own: never add electricity, heating and water together.
• Show confidence next to the numbers, and cost only with costCoverage (below 1, some hours have no price).
• If overlappingBuildingMeters is not empty, the total counts some consumption twice: say so.
• The current month is not complete yet: compare complete months only.