https://github.com/samccone/home-energy-score-api
API interface for the HES SOAP based API.
https://github.com/samccone/home-energy-score-api
Last synced: 2 months ago
JSON representation
API interface for the HES SOAP based API.
- Host: GitHub
- URL: https://github.com/samccone/home-energy-score-api
- Owner: samccone
- Created: 2014-01-30T02:19:49.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-03-09T01:06:56.000Z (over 12 years ago)
- Last Synced: 2025-10-05T17:22:38.975Z (9 months ago)
- Language: CoffeeScript
- Homepage:
- Size: 208 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Home Energy Saver API
===================
http://hes.lbl.gov/
This is a simple to use `node.js` API interface for the HES SOAP based API.
## Using in your project
* `npm install hes-score`
```coffeescript
require("hes-score")(zip, details, (response) =>
console.log response
)
```
## Using the demo file
* `EXPORT HES_ID="you_key";`
* `npm install`
* `npm start`
## Example
This is just a proof of concept example for how you can use this API interface.
The basic idea is as follows.
```coffee-script
homeScore ZIPCODE, [{
inputTableName: 'whole_house_input',
inputColumnName: 'floorArea'
s_value: '1800'
}], (data, error) ->
throw(error) if (error)
console.log data
```
## API
* API DOCS (tend to not be 100% correct)
* https://developers.buildingsapi.lbl.gov/hes/documentation/HES_API_methods
* PHP sample code
*https://developers.buildingsapi.lbl.gov/hes/documentation/php-5-api-sample-code