Skip to content

Get a property using an id

Returns the property's information if found using the given id.

This endpoint can return the address of the property, meter point's information, active agreements on a particular property, product and rates applicable based on the agreement, outage information based on the location of the property etc.

Authentication Required

Requires account user level access or CAN_QUERY_PROPERTY_METERS permission.

Arguments

  • accountNumber: String!

Returns

query getProperty($id: ID!){
  propery(id: $id) {
    id
    address
    addressLine1
    addressLine2
    addressLine3
    addressLine4
    addressLine5
    postcode
    meterPoints {
      id
      esiId
      serviceProvider
      loadZone
      loadProfile
      status
      hasCriticalCare
      meters {
        serialNumber
        activeFrom
        activeTo
      }
      agreements {
        id
        validFrom
        validTo
        agreedAt
        terminatedAt
        autoTopUpAmountSelectedByUser
        product {
          id
          marketName
          code
          notes
          fullName
          displayName
          description
          availableFrom
          availableTo
          term
          endsAt
          availabilityStatus
          termsContractType
        }
        activeProductRates {
          tdspRates {
            standingRates {
              taxable
              taxCode
              loadZone
              description
              serviceProvider
              unitType
              currency
              pricePerUnit
              bandCategory
              bandSubcategory
              band
            }
            consumptionRates {
              taxable
              taxCode
              loadZone
              description
              serviceProvider
              unitType
              currency
              pricePerUnit
              bandCategory
              bandSubcategory
              band
            }
          }
          loadZoneRates {
            consumptionRates {
              taxable
              taxCode
              loadZone
              description
              serviceProvider
              unitType
              currency
              pricePerUnit
              bandCategory
              bandSubcategory
              band
            }
          }
        }
        efls{
          id
          serviceProvider
          language
          url
        }
        totalApplicableRate
      }
    }
  }
}
1
2
3
4
5
6
# Input variables
{
    "input": {
        "id": 1,
    }
}

Example

Get property.

This query by default returns only the active agreements through the AgreementType. If you need agreements that will be active in the future, you can use the includeFutureActiveAgreements bool to query for it. See here for an example

query getProperty($id: ID!){
  propery(id: $id) {
    id
    address
    addressLine1
    addressLine2
    addressLine3
    addressLine4
    addressLine5
    postcode
    meterPoints {
      id
      esiId
      serviceProvider
      loadZone
      loadProfile
      status
      hasCriticalCare
      meters {
        serialNumber
        activeFrom
        activeTo
      }
      agreements {
        id
        validFrom
        validTo
        agreedAt
        terminatedAt
        autoTopUpAmountSelectedByUser
        product {
          id
          marketName
          code
          notes
          fullName
          displayName
          description
          availableFrom
          availableTo
          term
          endsAt
          availabilityStatus
          termsContractType
        }
        activeProductRates {
          tdspRates {
            standingRates {
              taxable
              taxCode
              loadZone
              description
              serviceProvider
              unitType
              currency
              pricePerUnit
              bandCategory
              bandSubcategory
              band
            }
            consumptionRates {
              taxable
              taxCode
              loadZone
              description
              serviceProvider
              unitType
              currency
              pricePerUnit
              bandCategory
              bandSubcategory
              band
            }
          }
          loadZoneRates {
            consumptionRates {
              taxable
              taxCode
              loadZone
              description
              serviceProvider
              unitType
              currency
              pricePerUnit
              bandCategory
              bandSubcategory
              band
            }
          }
        }
        efls{
          id
          serviceProvider
          language
          url
        }
        totalApplicableRate
      }
    }
  }
}
1
2
3
4
5
6
# Input variables
{
    "input": {
        "id": 1,
    }
}
{
    "data": {
        "property": {
            "id": "1",
            "address": "1000 ABCD St, Houston, TX 77098",
            "addressLine1": "1000 ABCD St",
            "addressLine2": "",
            "addressLine3": "",
            "addressLine4": "Houston",
            "addressLine5": "TX",
            "postcode": "77098",
            "meterPoints": [
                    {
                    "id": "000",
                    "esiId": "1008123456789788100",
                    "serviceProvider": "CENTERPOINT",
                    "loadZone": "LZ_HOUSTON",
                    "loadProfile": null,
                    "status": "ON_SUPPLY",
                    "hasCriticalCare": false,
                    "meters": null,
                    "agreements": [
                        {
                        "id": "1",
                        "validFrom": "2021-05-26T13:43:10.012679+00:00",
                        "validTo": null,
                        "agreedAt": "2021-05-25T20:34:09.458465+00:00",
                        "terminatedAt": null,
                        "autoTopUpAmountSelectedByUser": 5000,
                        "product": {
                            "id": "1",
                            "marketName": "USA_ERCOT_ELECTRICITY",
                            "code": "ERCOT-PREPAY-FIXED-30-2021",
                            "notes": "Initial load of products for ERCOT - fixed rate",
                            "fullName": "30-day Pre-Pay Fixed Rate",
                            "displayName": "30-Day Fixed Rate",
                            "description": "Fixed rate for 30 days",
                            "availableFrom": "2021-03-24T00:00:00-05:00",
                            "availableTo": null,
                            "term": 1,
                            "endsAt": null,
                            "availabilityStatus": "PUBLIC",
                            "termsContractType": ""
                        },
                        "activeProductRates": {
                            "tdspRates": {
                            "standingRates": [
                                {
                                "taxable": false,
                                "taxCode": null,
                                "loadZone": null,
                                "description": null,
                                "targetScope": null,
                                "serviceProvider": null,
                                "unitType": "MONTHS_ON_SUPPLY_PER_DIEM",
                                "currency": "USA_CENTS",
                                "pricePerUnit": "439.00000",
                                "bandCategory": "STANDING_CHARGE",
                                "bandSubcategory": "TDSP",
                                "band": "STANDING_CHARGE_TDSP_CENTERPOINT_BASE"
                                }
                            ],
                            "consumptionRates": [
                                {
                                "taxable": false,
                                "taxCode": null,
                                "loadZone": null,
                                "description": null,
                                "targetScope": null,
                                "serviceProvider": null,
                                "unitType": "KWH_CONSUMPTION",
                                "currency": "USA_CENTS",
                                "pricePerUnit": "4.26070",
                                "bandCategory": "CONSUMPTION_CHARGE",
                                "bandSubcategory": "TDSP",
                                "band": "CONSUMPTION_CHARGE_TDSP_CENTERPOINT_DELIVERY"
                                }
                            ]
                            },
                            "loadZoneRates": {
                            "consumptionRates": []
                            }
                        },
                        "efls": [
                            {
                            "id": "26",
                            "serviceProvider": "CENTERPOINT",
                            "language": "es",
                            "url": "https://oeus-prod-efl.s3.amazonaws.com:443/product_efls/2021/05/31/products/efls/ercot-prepay-fixed-30-2021-es-centerpoint-20210531.pdf?Signature=a8VRTjhmiwNgBSMTKCY8tGkDoFs%3D&Expires=1628686381&AWSAccessKeyId=ASIASNEMEKQHXIMCAB2J&x-amz-security-token=IQoJb3JpZ2luX2VjEL3//////////wEaCXVzLWVhc3QtMSJHMEUCIF9nyDcOvvW5cWiKhsA/ExwTTiecV6hLAchzQTGSwlEUAiEA9G4kmyEErmzOVyfN80CjAEznNpvQJyUOKMlJAd4FMWUqgwQI1v//////////ARABGgwxNjU2NTAxMjU4MzkiDERWj7kDiHSMo0NU3CrXAxRUIuvLcjKtBf3C2SfHAco428YnsSXmPjbRoCbmioBbT/LlZ3jO/T%2BAw6l4pKkmGKXnUJ%2B59IQ8FXHkWJzTG5snDGvqRlivF/bMMkYpGavFH4RbVHYD4QgGwgCqFPUbnoRZyrlQt93kzLrAn9MBvKQbGmqMuwgZBkn261DT3V3hDpLrVkfx7yUs68RXOwYQ5yjK0wGv0HyJKEhYw13KnhToTCg0l/%2BaEMJp37bfDNawBetOxfhQ0%2B2FzR7won/29BkCehvwBkmlvsmSVXdnKehZ11u8Q9AQlxewieZJoexVxRJ4Ki1PjYXoFcoXloImQ6buiXSpFyG2RPW3M8a7o8lmPHcjfW8XICKWtbkLTGzeaRrc3QMKLoj6aOx6R8tPJZSrn87UTAITcLEx9h8WW9vFLi6UvW6iHa7nhIedOlNly1YwDAgOt0oMANbD%2BF%2B0tGwTEDSr4bQZB/lBBjQxQfoyF2UnmRCNOFcvxdifSHK7xbHwNBJl8Cc6G7MIrzx2wWrel2GBWGtp8C/wcPBJ27zoHDXYQceYhx%2BvPaUw4kh6MPSS9cGZMWPaRypIbNuy1jBb9e57CSwe4ldwp%2Bg/iebMO7R4M6KLj4aAJnao54S13Y2JhyzgXDDvjM%2BIBjqlAWjuMWKWmr0gfZSMrUaoM1wG%2Bltw7MPzF/WFxyzOkJ3XVl96C93DMcLPqQAVKBdBYK9zETJqnBcr7MkYPh8AEnKMASF1jq1M6TNeUkNqhpHwEKEm82jhkmMO10I%2BlGRjzLTNFTpODfyPrYLBqFlVjdkYZ/OkxM9gyHUz/3nZnt4TiNjDvvpMjSMsxlXkzF50UuDXt6%2BY4mAfIrKfkBClrIc4zdDWpg%3D%3D"
                            },
                            {
                            "id": "27",
                            "serviceProvider": "CENTERPOINT",
                            "language": "en",
                            "url": "https://oeus-prod-efl.s3.amazonaws.com:443/product_efls/2021/05/31/products/efls/ercot-prepay-fixed-30-2021-en-centerpoint-20210531.pdf?Signature=CK665BY8vlp4OMwyYxdZ6K5zkBI%3D&Expires=1628686381&AWSAccessKeyId=ASIASNEMEKQHXIMCAB2J&x-amz-security-token=IQoJb3JpZ2luX2VjEL3//////////wEaCXVzLWVhc3QtMSJHMEUCIF9nyDcOvvW5cWiKhsA/ExwTTiecV6hLAchzQTGSwlEUAiEA9G4kmyEErmzOVyfN80CjAEznNpvQJyUOKMlJAd4FMWUqgwQI1v//////////ARABGgwxNjU2NTAxMjU4MzkiDERWj7kDiHSMo0NU3CrXAxRUIuvLcjKtBf3C2SfHAco428YnsSXmPjbRoCbmioBbT/LlZ3jO/T%2BAw6l4pKkmGKXnUJ%2B59IQ8FXHkWJzTG5snDGvqRlivF/bMMkYpGavFH4RbVHYD4QgGwgCqFPUbnoRZyrlQt93kzLrAn9MBvKQbGmqMuwgZBkn261DT3V3hDpLrVkfx7yUs68RXOwYQ5yjK0wGv0HyJKEhYw13KnhToTCg0l/%2BaEMJp37bfDNawBetOxfhQ0%2B2FzR7won/29BkCehvwBkmlvsmSVXdnKehZ11u8Q9AQlxewieZJoexVxRJ4Ki1PjYXoFcoXloImQ6buiXSpFyG2RPW3M8a7o8lmPHcjfW8XICKWtbkLTGzeaRrc3QMKLoj6aOx6R8tPJZSrn87UTAITcLEx9h8WW9vFLi6UvW6iHa7nhIedOlNly1YwDAgOt0oMANbD%2BF%2B0tGwTEDSr4bQZB/lBBjQxQfoyF2UnmRCNOFcvxdifSHK7xbHwNBJl8Cc6G7MIrzx2wWrel2GBWGtp8C/wcPBJ27zoHDXYQceYhx%2BvPaUw4kh6MPSS9cGZMWPaRypIbNuy1jBb9e57CSwe4ldwp%2Bg/iebMO7R4M6KLj4aAJnao54S13Y2JhyzgXDDvjM%2BIBjqlAWjuMWKWmr0gfZSMrUaoM1wG%2Bltw7MPzF/WFxyzOkJ3XVl96C93DMcLPqQAVKBdBYK9zETJqnBcr7MkYPh8AEnKMASF1jq1M6TNeUkNqhpHwEKEm82jhkmMO10I%2BlGRjzLTNFTpODfyPrYLBqFlVjdkYZ/OkxM9gyHUz/3nZnt4TiNjDvvpMjSMsxlXkzF50UuDXt6%2BY4mAfIrKfkBClrIc4zdDWpg%3D%3D"
                            }
                        ],
                        "outageInformation": {
                            "serviceProvider": "CENTERPOINT",
                            "link": "https://www.centerpointenergy.com/en-us/residential/customer-service/electric-outage-center?sa=ho",
                            "outageReportNumber": "(713) 207-2222",
                            "serviceRequestNumber": "(800) 332-7143"
                        }
                    }
                    ]
                }
            ]
        }
    }
}

Get property with active or future active agreements

 query getProperty($id: ID!){
  propery(id: $id) {
    id
    address
    addressLine1
    addressLine2
    addressLine3
    addressLine4
    addressLine5
    postcode
    meterPoints {
      id
      esiId
      serviceProvider
      loadZone
      loadProfile
      status
      hasCriticalCare
      meters {
        serialNumber
        activeFrom
        activeTo
      }
      agreements(includeFutureActiveAgreements:$includeFutureActiveAgreements){
        id
        validFrom
        validTo
        agreedAt
        terminatedAt
        autoTopUpAmountSelectedByUser
        product {
          id
          marketName
          code
          notes
          fullName
          displayName
          description
          availableFrom
          availableTo
          term
          endsAt
          availabilityStatus
          termsContractType
        }
        activeProductRates {
          tdspRates {
            standingRates {
              taxable
              taxCode
              loadZone
              description
              serviceProvider
              unitType
              currency
              pricePerUnit
              bandCategory
              bandSubcategory
              band
            }
            consumptionRates {
              taxable
              taxCode
              loadZone
              description
              serviceProvider
              unitType
              currency
              pricePerUnit
              bandCategory
              bandSubcategory
              band
            }
          }
          loadZoneRates {
            consumptionRates {
              taxable
              taxCode
              loadZone
              description
              serviceProvider
              unitType
              currency
              pricePerUnit
              bandCategory
              bandSubcategory
              band
            }
          }
        }
        efls{
          id
          serviceProvider
          language
          url
        }
        totalApplicableRate
      }
    }
  }
}
1
2
3
4
5
6
7
# Input variables
{
    "input": {
        "id": "1",
        "includeFutureActiveAgreements":True,
    }
}
{
  "property": {
      "id": "70",
      "address": "64 Downing Street, ,  77004",
      "addressLine1": "64 Downing Street",
      "addressLine2": "",
      "addressLine3": "",
      "addressLine4": "",
      "addressLine5": "",
      "postcode": "10004",
      "meterPoints": [
        {
          "id": "41",
          "esiId": "1017699159980872164",
          "serviceProvider": "AEP_TCC",
          "loadZone": "LZ_SOUTH",
          "loadProfile": null,
          "status": "ON_SUPPLY",
          "hasCriticalCare": false,
          "meters": null,
          "agreements": [
                    {
                    "id": "1",
                    "validFrom": "2024-05-26T13:43:10.012679+00:00",
                    "validTo": null,
                    "agreedAt": "2022-10-14T20:34:09.458465+00:00",
                    "terminatedAt": null,
                    "autoTopUpAmountSelectedByUser": 5000,
                    "product": {
                        "id": "1",
                        "marketName": "USA_ERCOT_ELECTRICITY",
                        "code": "ERCOT-PREPAY-FIXED-30-2021",
                        "notes": "Initial load of products for ERCOT - fixed rate",
                        "fullName": "30-day Pre-Pay Fixed Rate",
                        "displayName": "30-Day Fixed Rate",
                        "description": "Fixed rate for 30 days",
                        "availableFrom": "2022-10-14T00:00:00-05:00",
                        "availableTo": null,
                        "term": 1,
                        "endsAt": null,
                        "availabilityStatus": "PUBLIC",
                        "termsContractType": ""
                    },
                    "activeProductRates": {
                        "tdspRates": {
                        "standingRates": [
                            {
                            "taxable": false,
                            "taxCode": null,
                            "loadZone": null,
                            "description": null,
                            "targetScope": null,
                            "serviceProvider": null,
                            "unitType": "MONTHS_ON_SUPPLY_PER_DIEM",
                            "currency": "USA_CENTS",
                            "pricePerUnit": "439.00000",
                            "bandCategory": "STANDING_CHARGE",
                            "bandSubcategory": "TDSP",
                            "band": "STANDING_CHARGE_TDSP_CENTERPOINT_BASE"
                            }
                        ],
                        "consumptionRates": [
                            {
                            "taxable": false,
                            "taxCode": null,
                            "loadZone": null,
                            "description": null,
                            "targetScope": null,
                            "serviceProvider": null,
                            "unitType": "KWH_CONSUMPTION",
                            "currency": "USA_CENTS",
                            "pricePerUnit": "4.26070",
                            "bandCategory": "CONSUMPTION_CHARGE",
                            "bandSubcategory": "TDSP",
                            "band": "CONSUMPTION_CHARGE_TDSP_CENTERPOINT_DELIVERY"
                            }
                        ]
                        },
                        "loadZoneRates": {
                        "consumptionRates": []
                        }
                    },
                    "efls": [
                        {
                        "id": "26",
                        "serviceProvider": "CENTERPOINT",
                        "language": "es",
                        "url": "https://oeus-prod-efl.s3.amazonaws.com:443/product_efls/2021/05/31/products/efls/ercot-prepay-fixed-30-2021-es-centerpoint-20210531.pdf?Signature=a8VRTjhmiwNgBSMTKCY8tGkDoFs%3D&Expires=1628686381&AWSAccessKeyId=ASIASNEMEKQHXIMCAB2J&x-amz-security-token=IQoJb3JpZ2luX2VjEL3//////////wEaCXVzLWVhc3QtMSJHMEUCIF9nyDcOvvW5cWiKhsA/ExwTTiecV6hLAchzQTGSwlEUAiEA9G4kmyEErmzOVyfN80CjAEznNpvQJyUOKMlJAd4FMWUqgwQI1v//////////ARABGgwxNjU2NTAxMjU4MzkiDERWj7kDiHSMo0NU3CrXAxRUIuvLcjKtBf3C2SfHAco428YnsSXmPjbRoCbmioBbT/LlZ3jO/T%2BAw6l4pKkmGKXnUJ%2B59IQ8FXHkWJzTG5snDGvqRlivF/bMMkYpGavFH4RbVHYD4QgGwgCqFPUbnoRZyrlQt93kzLrAn9MBvKQbGmqMuwgZBkn261DT3V3hDpLrVkfx7yUs68RXOwYQ5yjK0wGv0HyJKEhYw13KnhToTCg0l/%2BaEMJp37bfDNawBetOxfhQ0%2B2FzR7won/29BkCehvwBkmlvsmSVXdnKehZ11u8Q9AQlxewieZJoexVxRJ4Ki1PjYXoFcoXloImQ6buiXSpFyG2RPW3M8a7o8lmPHcjfW8XICKWtbkLTGzeaRrc3QMKLoj6aOx6R8tPJZSrn87UTAITcLEx9h8WW9vFLi6UvW6iHa7nhIedOlNly1YwDAgOt0oMANbD%2BF%2B0tGwTEDSr4bQZB/lBBjQxQfoyF2UnmRCNOFcvxdifSHK7xbHwNBJl8Cc6G7MIrzx2wWrel2GBWGtp8C/wcPBJ27zoHDXYQceYhx%2BvPaUw4kh6MPSS9cGZMWPaRypIbNuy1jBb9e57CSwe4ldwp%2Bg/iebMO7R4M6KLj4aAJnao54S13Y2JhyzgXDDvjM%2BIBjqlAWjuMWKWmr0gfZSMrUaoM1wG%2Bltw7MPzF/WFxyzOkJ3XVl96C93DMcLPqQAVKBdBYK9zETJqnBcr7MkYPh8AEnKMASF1jq1M6TNeUkNqhpHwEKEm82jhkmMO10I%2BlGRjzLTNFTpODfyPrYLBqFlVjdkYZ/OkxM9gyHUz/3nZnt4TiNjDvvpMjSMsxlXkzF50UuDXt6%2BY4mAfIrKfkBClrIc4zdDWpg%3D%3D"
                        },
                        {
                        "id": "27",
                        "serviceProvider": "CENTERPOINT",
                        "language": "en",
                        "url": "https://oeus-prod-efl.s3.amazonaws.com:443/product_efls/2021/05/31/products/efls/ercot-prepay-fixed-30-2021-en-centerpoint-20210531.pdf?Signature=CK665BY8vlp4OMwyYxdZ6K5zkBI%3D&Expires=1628686381&AWSAccessKeyId=ASIASNEMEKQHXIMCAB2J&x-amz-security-token=IQoJb3JpZ2luX2VjEL3//////////wEaCXVzLWVhc3QtMSJHMEUCIF9nyDcOvvW5cWiKhsA/ExwTTiecV6hLAchzQTGSwlEUAiEA9G4kmyEErmzOVyfN80CjAEznNpvQJyUOKMlJAd4FMWUqgwQI1v//////////ARABGgwxNjU2NTAxMjU4MzkiDERWj7kDiHSMo0NU3CrXAxRUIuvLcjKtBf3C2SfHAco428YnsSXmPjbRoCbmioBbT/LlZ3jO/T%2BAw6l4pKkmGKXnUJ%2B59IQ8FXHkWJzTG5snDGvqRlivF/bMMkYpGavFH4RbVHYD4QgGwgCqFPUbnoRZyrlQt93kzLrAn9MBvKQbGmqMuwgZBkn261DT3V3hDpLrVkfx7yUs68RXOwYQ5yjK0wGv0HyJKEhYw13KnhToTCg0l/%2BaEMJp37bfDNawBetOxfhQ0%2B2FzR7won/29BkCehvwBkmlvsmSVXdnKehZ11u8Q9AQlxewieZJoexVxRJ4Ki1PjYXoFcoXloImQ6buiXSpFyG2RPW3M8a7o8lmPHcjfW8XICKWtbkLTGzeaRrc3QMKLoj6aOx6R8tPJZSrn87UTAITcLEx9h8WW9vFLi6UvW6iHa7nhIedOlNly1YwDAgOt0oMANbD%2BF%2B0tGwTEDSr4bQZB/lBBjQxQfoyF2UnmRCNOFcvxdifSHK7xbHwNBJl8Cc6G7MIrzx2wWrel2GBWGtp8C/wcPBJ27zoHDXYQceYhx%2BvPaUw4kh6MPSS9cGZMWPaRypIbNuy1jBb9e57CSwe4ldwp%2Bg/iebMO7R4M6KLj4aAJnao54S13Y2JhyzgXDDvjM%2BIBjqlAWjuMWKWmr0gfZSMrUaoM1wG%2Bltw7MPzF/WFxyzOkJ3XVl96C93DMcLPqQAVKBdBYK9zETJqnBcr7MkYPh8AEnKMASF1jq1M6TNeUkNqhpHwEKEm82jhkmMO10I%2BlGRjzLTNFTpODfyPrYLBqFlVjdkYZ/OkxM9gyHUz/3nZnt4TiNjDvvpMjSMsxlXkzF50UuDXt6%2BY4mAfIrKfkBClrIc4zdDWpg%3D%3D"
                        }
                    ],
                    "outageInformation": {
                        "serviceProvider": "CENTERPOINT",
                        "link": "https://www.centerpointenergy.com/en-us/residential/customer-service/electric-outage-center?sa=ho",
                        "outageReportNumber": "(713) 207-2222",
                        "serviceRequestNumber": "(800) 332-7143"
                    }
                }
            ]
        }
    }
}
Back to top