propertySearch

Search for properties that are already in Kraken and match the search term.

Deprecation

The 'propertySearch' field is deprecated.

This query is being deprecated in favour of `propertiesSearch`. The latter returns not only the matched properties but the level of confidence in the results through the `score` field.

- Marked as deprecated on 2023-05-23.
- Scheduled for removal on or after 2024-01-01.

Arguments

searchTerm : String!


            required

The search term. It can be an address or a meter point identifier.

Returns

[PropertyType]

Represents a property. Conceptually, it collects supply points under an address.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query property

Query Complexity

Examples

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.

query PropertySearch($searchTerm: String!) {
  propertySearch(searchTerm: $searchTerm) {
    address
    ancestors {
      ...PropertyConnectionFragment
    }
    availableSmets2InstallationTimeslots {
      ...Smets2InstallationTimeslotTypeFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    descendants {
      ...PropertyConnectionFragment
    }
    electricityMeterPoints {
      ...ElectricityMeterPointTypeFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    gasMeterPoints {
      ...GasMeterPointTypeFragment
    }
    id
    isChangeOfTenancyOngoing
    isSmets2InstallationAllowed
    label
    measurements {
      ...MeasurementConnectionFragment
    }
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    parent {
      ...PropertyInterfaceFragment
    }
    postcode
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    smartDeviceNetworks {
      ...SmartMeterDeviceNetworkTypeFragment
    }
    splitAddress
    wanCoverage
  }
}

{
  "searchTerm": "film-few-media-only-nearly"
}

{
  "data": {
    "propertySearch": [
      {
        "address": "with-clear-PM-yes-save",
        "ancestors": PropertyConnection,
        "availableSmets2InstallationTimeslots": [Smets2InstallationTimeslotType],
        "coordinates": CoordinatesType,
        "descendants": PropertyConnection,
        "electricityMeterPoints": [ElectricityMeterPointType],
        "embeddedNetwork": EmbeddedNetworkType,
        "gasMeterPoints": [GasMeterPointType],
        "id": "85954955",
        "isChangeOfTenancyOngoing": true,
        "isSmets2InstallationAllowed": true,
        "label": "already-inside-example-probably-seem",
        "measurements": MeasurementConnection,
        "occupancyPeriods": [OccupancyPeriodType],
        "parent": PropertyInterface,
        "postcode": "adult-bed-bed-above-especially",
        "richAddress": PropertyRichAddressType,
        "smartDeviceNetworks": [SmartMeterDeviceNetworkType],
        "splitAddress": "evening-sit-player-system-shoulder",
        "wanCoverage": "HIGH"
      }
    ]
  }
}