Skip to main content

Building Parameters

Buildings allow Partners to group devices by physical location, enabling better consumption tracking and multi-property management.

Required Parameters

owner
string (UUID)
required
User ID that owns this building.Example: 016b78a7-0c7c-4241-a277-015c3ad3cb90Writable: No (set at creation)
name
string
required
Custom name for the building.Example: Vacation HomeWritable: Yes

Property Information

property_type
enum
Type of property.Options: Detached, Semi-detached, Bungalow, Terraced, End-terrace, FlatExample: DetachedWritable: Yes
property_size_m2
integer
Property size in square meters.Example: 220Writable: Yes
property_age
integer
Age of the property in years.Example: 15Writable: Yes

Occupancy Information

num_occupants
integer
Number of people living in the building.Example: 4Writable: Yes
occupant_type
enum
Type of occupants living in the building.Options: Students, Working adults, At home adults, Young family, Older family, RetireesExample: FamilyWritable: Yes

Heating Systems

space_heating
enum
Type of space heating system used.Options: Gas boiler, Electric storage, Electric heaters, Heat pump, Oil boiler, Solar, Other, Hybrid heat pump, District heating, Wood pelletExample: Heat pumpWritable: Yes
water_heating
enum
Type of water heating system used.Options: Gas boiler, Electric, Oil boiler, Solar, Heat pump, OtherExample: Heat pumpWritable: Yes

Address Information

street_and_number
string
Primary street address with house number.Example: Platz der Republik 1Writable: Yes
street_add_info
string
Additional address information.Example: Apt 4BWritable: Yes
zip_code
integer
Postal/ZIP code.Example: 11011Writable: Yes
town
string
City or town name.Example: BerlinWritable: Yes
country_iso2
string
Country code in ISO 3166-1 alpha-3 format.Example: DEUWritable: Yes

Usage Examples

Create Building

curl -X POST \
  'https://app.podero.com/api/partners/v2.0/org/{org_id}/users/{user_id}/buildings' \
  -H 'Authorization: Bearer {auth_token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Main Residence",
    "property_type": "Detached",
    "property_size_m2": 220,
    "num_occupants": 4,
    "space_heating": "Heat pump",
    "water_heating": "Heat pump"
  }'