Get all properties associated with an account¶
Returns all the properties associated with an account.
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
Example¶
Get all properties.¶
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 getProperties($accountNumber: String!){
properties(accountNumber: $accountNumber) {
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
}
}
}
}
{
"data": {
"properties": [
{
"id": "000",
"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": "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=nEc4V4Hq5t433BF9O6FgR55pUr0%3D&Expires=1628686523&AWSAccessKeyId=ASIASNEMEKQHZ6AQIDVP&x-amz-security-token=IQoJb3JpZ2luX2VjEL3//////////wEaCXVzLWVhc3QtMSJHMEUCIGepI%2BJsyw0mjsx2ps8ixSku66Ax1tkTgsWlfTdieXOnAiEA9SF4yBYHloVk9ISytpItD/X9NCEGKvLS1k1AZ23hjisqgwQI1v//////////ARABGgwxNjU2NTAxMjU4MzkiDOiuznO4te9J1NGeyyrXA9nlg4bgnM5VbIVY2OURjgDOKCu%2BvWbDJJ6AMiUo%2BTrZCHyoKGvSNMKdGHHmAaK20zewuzsORZBSlQuq7aNOLZbO56EGGIXyzcIDTXpKguoJrcOsEB83YTeiKogEQcnFF6d9s5ONwIDO%2BaD3HapxssjfOYDXj03tDXu5zgSEHR8tWCizRnp87/KjruDLFYvSowBZla64paaCNlxBC5oY3uUxw6hPkFr%2BPETCqwGX9GHfd7giLogDYO9yOKfnEPFpKnalbDVQX2aPBJi6iwxdD2YDlZ2DzgO8DR/ZZFicQ/sM2LT9r7cP0Zb85GhwMwet%2BYIcLjZB9/EmJnE5ivvNY%2B2clrKWWPrXpFl8FCaq74T5IWwNHk08Cv6GpvZOlQidOnEcMromz5uDcmNG8Sg2slbuprgFwMsUlUgjKNT0y6ohSgOtki4NDIknxVnnDJYjUUbVd97gBiKFMPPLO2FgsLMHpYc%2BR2eXmxYsCeCJLFnhF0h4mrOEz5mpa9oq4t%2BgyJ9v4Rzbdx1QYK2AZi6GeuO9CDBE8loqo5daAgofOrkHUCxV4XxLzlx7tgKLnVoCxKlj7va50rJeAtQnszR3apOJQW8xW2TYtDVlX7V0BrhPA4MazEW7YTDtjM%2BIBjqlAXNTu7sVVSj8UeW2PvfpE6%2B4dw3eJHExGOOUwO619SQd4AjAogJv7jvfMy1lBr48rd4YnzUFHXdgqjb8LpFIGNF6nS83oCtA54usdPXBW2QkPt6VypWWIny6b0ccIo1Nn%2BetS0CVPthC41EaVXXrVPrvvNEeq8/xvh5XA7dHUN6H3SUzUIM1CR13333oDtAtmzRq/AhdLIjnV6W6qLdhPW1RY1pQsw%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 all properties with active or future active agreements¶
query getProperties($accountNumber: String!, $includeFutureActiveAgreements:Boolean!){
properties(accountNumber: $accountNumber) {
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
}
}
}
}
{
"properties": [
{
"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": "49",
"validFrom": "2022-10-09T13:33:13.112159+00:00",
"validTo": "2023-01-17T13:33:13.112159+00:00",
"agreedAt": "2022-10-09T13:33:13.112159+00:00",
"terminatedAt": null,
"autoTopUpAmountSelectedByUser": null,
"product": {
"id": "49",
"marketName": "USA_ERCOT_ELECTRICITY",
"code": "ercot-market-supply-product-0-code",
"notes": "",
"fullName": "Ercotmarketsupplyproduct0Code",
"displayName": "Display1",
"description": "Product description for fixed rate",
"availableFrom": "2021-10-09T00:00:00-05:00",
"availableTo": null,
"term": null,
"endsAt": null,
"availabilityStatus": "PUBLIC",
"termsContractType": "MARKET_RETAIL"
},
"activeProductRates": {
"tdspRates": {
"standingRates": [
{
"taxable": false,
"taxCode": null,
"loadZone": null,
"description": "TDSP Monthly Fee AEP_TCC",
"serviceProvider": "AEP_TCC",
"unitType": "MONTHS_ON_SUPPLY",
"currency": "USA_CENTS",
"pricePerUnit": "0.10000",
"bandCategory": "STANDING_CHARGE",
"bandSubcategory": "FIXED",
"band": "STANDING_CHARGE_TDSP_AEP_TCC"
}
],
"consumptionRates": [
{
"taxable": false,
"taxCode": null,
"loadZone": null,
"description": "TDSP Delivery Charge AEP_TCC",
"serviceProvider": "AEP_TCC",
"unitType": "KWH_CONSUMPTION",
"currency": "USA_CENTS",
"pricePerUnit": "5.00000",
"bandCategory": "CONSUMPTION_CHARGE",
"bandSubcategory": "TDSP",
"band": "CONSUMPTION_CHARGE_TDSP_AEP_TCC"
}
]
},
"loadZoneRates": {
"consumptionRates": []
}
},
"efls": [],
"totalApplicableRate": "5.00010"
},
{
"id": "50",
"validFrom": "2023-10-09T13:33:13.112159+00:00",
"validTo": "2025-04-09T13:33:13.112159+00:00",
"agreedAt": "2023-10-09T13:33:13.112159+00:00",
"terminatedAt": null,
"autoTopUpAmountSelectedByUser": null,
"product": {
"id": "50",
"marketName": "USA_ERCOT_ELECTRICITY",
"code": "ercot-market-supply-product-1-code",
"notes": "",
"fullName": "Ercotmarketsupplyproduct1Code",
"displayName": "Display2",
"description": "Product description for fixed rate",
"availableFrom": "2021-10-14T00:00:00-05:00",
"availableTo": null,
"term": null,
"endsAt": null,
"availabilityStatus": "PUBLIC",
"termsContractType": "MARKET_RETAIL"
},
"activeProductRates": {
"tdspRates": {
"standingRates": [
{
"taxable": false,
"taxCode": null,
"loadZone": null,
"description": "TDSP Monthly Fee AEP_TCC",
"serviceProvider": "AEP_TCC",
"unitType": "MONTHS_ON_SUPPLY",
"currency": "USA_CENTS",
"pricePerUnit": "0.10000",
"bandCategory": "STANDING_CHARGE",
"bandSubcategory": "FIXED",
"band": "STANDING_CHARGE_TDSP_AEP_TCC"
}
],
"consumptionRates": [
{
"taxable": false,
"taxCode": null,
"loadZone": null,
"description": "TDSP Delivery Charge AEP_TCC",
"serviceProvider": "AEP_TCC",
"unitType": "KWH_CONSUMPTION",
"currency": "USA_CENTS",
"pricePerUnit": "5.00000",
"bandCategory": "CONSUMPTION_CHARGE",
"bandSubcategory": "TDSP",
"band": "CONSUMPTION_CHARGE_TDSP_AEP_TCC"
}
]
},
"loadZoneRates": {
"consumptionRates": []
}
},
"efls": [],
"totalApplicableRate": "5.00010"
}
]
}
]
}
]
}}