Skip to main content

Fields

address : String

The address of the property, formatted into a single string.

ancestors : PropertyConnection

Ancestor properties in the specified hierarchy, ordered from root to immediate parent. Returns empty list if the property is not in the hierarchy.

Arguments
after : String
before : String
first : Int
hierarchyName : String default: default

The name of the hierarchy to query within.

last : Int
availableSmets2InstallationTimeslots : [Smets2InstallationTimeslotType]

Timeslots for which the property has the possibility to book a smart-meter installation.

coordinates : CoordinatesType

Coordinates for the property, useful for displaying the property on a map.

descendants : PropertyConnection

Descendant properties in the specified hierarchy. Returns empty list if the property is not in the hierarchy.

Arguments
after : String
before : String
depth : Int default: 1

Maximum depth of descendants to return. Defaults to 1 (immediate children). Set to null for all descendants.

first : Int
hierarchyName : String default: default

The name of the hierarchy to query within.

last : Int
electricityMeterPoints : [ElectricityMeterPointType]

Retrieve the details of electricity meter-points for a property.

embeddedNetwork : EmbeddedNetworkType

The embedded network this property belongs to, if any.

gasMeterPoints : [GasMeterPointType]

Retrieve the details of gas meter-points for a property.

id : String
isChangeOfTenancyOngoing : Boolean
isSmets2InstallationAllowed : Boolean

Indicates if the property meets smart meter install preconditions.

label : String

An optional label for the property.

measurements : MeasurementConnection

Measurements at a property

Arguments
after : String
before : String
endAt : DateTime default: 9999-12-29T23:59:59.999999+00:00

Defaults to the far future which will return the most recent readings.

endOn : Date

Latest date to return measurements for (inclusive).

first : Int
last : Int
startAt : DateTime default: 0001-01-03T00:00:00-00:01:15

Defaults to the far past which will return the oldest readings.

startOn : Date

Earliest date to return measurements from.

timezone : String default: Europe/London

Timezone to use for grouping. Defaults to Kraken localtime.

utilityFilters : [UtilityFiltersInput]

Filters for each utility being measured.

occupancyPeriods : [OccupancyPeriodType]

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
hierarchyName : String default: default

The name of the hierarchy to query within.

postcode : String! required
richAddress : PropertyRichAddressType

Property rich address.

smartDeviceNetworks : [SmartMeterDeviceNetworkType]

Retrieve any smartmeter devices connected to the property.

splitAddress : [String]

List of address lines.

wanCoverage : WANCoverageStrengths

Likelihood that a smart meter at the given postcode and address will get a stable network connection.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

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" }