Function getUtilityComparison
Description
This function returns data on how your utility bills and carbon usage compare to other similar homes.
Parameters
| Parameter |
Description |
Required |
| key |
Your API Key. Contact us to get one. |
Yes |
| function |
Function to execute (getUtilityComparison). |
Yes |
| zipcode |
Zip code valid (US). |
Yes |
| homeSquareFeet |
Size of your home in square feet as an number (e.g. 1700) |
Yes |
| output |
Return results in XML or JSON (defaults to XML). |
No |
| averageMonthlyBill |
How much do you spend on gas and electricity in an average month. |
No |
Sample Function Call
http://www.wattzon.com/api-function?key=<YOUR-API-KEY>&function=getUtilityComparison&zipcode=12345&homeSquareFeet=1700
&averageMonthlyBill=200&output=XML
Function Results
| Parameter |
Description |
| request |
Request from client. |
| function |
Execution function. |
| output |
Format data returned. |
| response |
Response from service. |
| code |
Status code of the result (see information below). |
| msg |
Further information about the result. |
| results |
The results of the comparison. |
| yourEnergyBill |
Your total annual energy bill in $ |
| efficientEnergyBill |
Total annual energy bill of similar energy efficient local homes in $ |
| averageEnergyBill |
Average total annual energy bill of similar local homes in $ |
| yourCarbon |
Your total annual carbon emissions (from home energy consumption) in LBS |
| efficientCarbon |
Annual carbon emissions of similar energy efficient local homes in LBS |
| averageCarbon |
Average total annual carbon emissions from similar local homes in LBS |
Sample Function Response
<api>
<request>
<function>getUtilityComparison</function>
<zipcode>12345</zipcode>
<homeSquareFeet>1700</homeSquareFeet>
<averageMonthlyBill>200</averageMonthlyBill>
<output>xml</output>
</request>
<response>
<code>200</code>
<msg>OK</msg>
</response>
<results>
<yourEnergyBill>2400</yourEnergyBill>
<efficientEnergyBill>2183</efficientEnergyBill>
<averageEnergyBill>5084</averageEnergyBill>
<yourCarbon>14679</yourCarbon>
<efficientCarbon>13280</efficientCarbon>
<averageCarbon>31096</averageCarbon>
</results>
</api>
