Wattvision API Definition
The API allows developers to create products that are wattvision-enabled. The Upload API allows you to upload your home's energy use data to wattvision's servers, for storage, comparison, sharing, and visualization. The Download API allows you to access the data for your house. These APIs are in BETA and the API is subject to change, so watch this page for updates.
UPLOAD API: send data to wattvision (v0.1)
Make an HTTP POST to the following URL:
http://www.wattvision.com/api
h=123123
k=90232Dde3432334
v=0.1
watts=1230
Required Parameters
| h | Your House ID. Available on the settings page. ("My House" > "Settings") |
|---|---|
| k | Your Secret Key. Available on the settings page. ("My House" > "Settings") |
| v | API Version. It's 0.1 |
| watts | The present consumption in watts (as a float). |
Optional Parameters
| time | The UTC timestamp for this data point, in exactly this format (ISO datetime): YYYY-MM-DDTHH:MM:SS. Note, this is not your local time, but UTC. When not submitted, the server timestamps the time, so network delays may an issue. |
|---|---|
| wh_consumed | The number (integer) of whole watt-hours consumed since the last data post. Partial watt-hours should be part of the next data point. If you do not include wh_consumed, we will estimate wh_consumed by 'integrating' watts x time. |
| ms_per_wh | Instead of 'watts', you may submit the present consumption rate in milliseconds per watt-hour (integer number). Rounded to the nearest millisecond. |
Update Strategy
Post data as slow as once every 20 minutes, or as fast as every 15 seconds. We can accept data faster than every 15 seconds -- if you want to do that, email info@. Do not attempt to upload at exactly :00, :15, :45, etc -- instead, just set your timer to fire at a set period and start at an arbitrary time.
If you want to have your sensor showing as "sensor active" you must consistently upload faster than once every 5 minutes.
Response Codes
Right now, everything returns "HTTP 200 OK" with some explanatory text on error or 'data added' if it worked.
DOWNLOAD API: get data from wattvision
The Download API is experimental. Let us know how you are using it at info@wattvision.com. Thanks!
Get the last 5 minutes of data:
http://www.wattvision.com/api/download?h=HOUSE_ID&k=API_KEY&v=0.1
Required Parameters
| h | Your House ID. Available on the settings page. ("My House" > "Settings") |
|---|---|
| k | Your Secret Key. Available on the settings page. ("My House" > "Settings") |
| v | API Version. It's 0.1 |
Return Format
- returns the last 5 minutes of data
- returns a JSON array with the following format:
- first item is an array [ house_name, 0, 0 ]
- remaining items are arrays formatted as [ unix time, watts, cents ]
- Cents is "cost in cents per hour"
Get the most recent datapoint:
http://www.wattvision.com/api/download/latest?h=HOUSE_ID&k=API_KEY&v=0.1
Required Parameters
| h | Your House ID. Available on the settings page. ("My House" > "Settings") |
|---|---|
| k | Your Secret Key. Available on the settings page. ("My House" > "Settings") |
| v | API Version. It's 0.1 |
Return Format
- returns the most recent data point from wattvision's servers
- returns a JSON array with 3 items [ unix time, watts, cents ]
- Cents is "cost in cents per hour"
