PropertyType
Represents a property. Conceptually, it collects supply points under an address.
Fields
The address of the property, formatted into a single string.
Ancestor properties in the specified hierarchy, ordered from root to immediate parent. Returns empty list if the property is not in the hierarchy.
Timeslots for which the property has the possibility to book a smart-meter installation.
Coordinates for the property, useful for displaying the property on a map.
Descendant properties in the specified hierarchy. Returns empty list if the property is not in the hierarchy.
Retrieve the details of electricity meter-points for a property.
The embedded network this property belongs to, if any.
Retrieve the details of gas meter-points for a property.
Indicates if the property meets smart meter install preconditions.
An optional label for the property.
Measurements at a property
Arguments
Defaults to the far future which will return the most recent readings.
Latest date to return measurements for (inclusive).
Defaults to the far past which will return the oldest readings.
Earliest date to return measurements from.
Timezone to use for grouping. Defaults to Kraken localtime.
Filters for each utility being measured.
Time periods during which the property is associated with an account. Useful to display information about house-moves, as performing a move out of a property will set the end date for the occupancy period.
The parent property in the specified hierarchy. Returns null if the property has no parent or is not in the hierarchy.
Arguments
The name of the hierarchy to query within.
Property rich address.
Retrieve any smartmeter devices connected to the property.
List of address lines.
Likelihood that a smart meter at the given postcode and address will get a stable network connection.
Example
{
"address": "air-push-sound-process-international",
"ancestors": PropertyConnection,
"availableSmets2InstallationTimeslots": [Smets2InstallationTimeslotType],
"coordinates": CoordinatesType,
"descendants": PropertyConnection,
"electricityMeterPoints": [ElectricityMeterPointType],
"embeddedNetwork": EmbeddedNetworkType,
"gasMeterPoints": [GasMeterPointType],
"id": "50078212",
"isChangeOfTenancyOngoing": true,
"isSmets2InstallationAllowed": true,
"label": "call-deep-answer-audience-baby",
"measurements": MeasurementConnection,
"occupancyPeriods": [OccupancyPeriodType],
"parent": PropertyInterface,
"postcode": "true-fear-citizen-north-candidate",
"richAddress": PropertyRichAddressType,
"smartDeviceNetworks": [SmartMeterDeviceNetworkType],
"splitAddress": "night-sure-opportunity-design-too",
"wanCoverage": "HIGH"
}