Efergy Engage API Reference - part 2

Update 12 Feb 2015

There appears to be an official api document available from energyhive, it can be found on http://napi.hbcontent.com/document/index.php. Thanks to Robert R for sharing in it in the comments.

getTimeSeries

Get aggregated data for a specified period.
See Energyhive development page for more information.

getBudget

Gets the monthly budget that has been set in the settings on the engage portal.

Url : https://engage.efergy.com/mobile_proxy/
Function : getBudget
Example:

https://engage.efergy.com/mobile_proxy/getBudget?token=token

Result:

{"status":"ok", "monthly_budget":40.0000}

getCarbon

Get the calculated amount of carbon emission, depends on the carbon emission ratio in the settings and the total power usage in the specified period

Url : https://engage.efergy.com/mobile_proxy
Function : getCarbon
Parameters :

Example :

https://engage.efergy.com/mobile_proxy/getCarbon?token=token&offset=2&period=month

Result :

{"sum":"189.53","duration":2537100,"units":"kg co2"}

The duration are the number of seconds over which are included in the summation.

getCost

Get the calculated amount of money that the power usage will cost, depends on the tariff that is set in the settings and the total power usage in the specified period.

Url : https://engage.efergy.com/mobile_proxy
Function : getCost
Parameters :

Example :

https://engage.efergy.com/mobile_proxy/getCost?token=token&offset=2&period=month

Result :

{"sum":"30.37","duration":2537580,"units":"GBP"}

The duration are the number of seconds over which are included in the summation.
The units value might actually be a bug in the api, as i have set Euro in my settings, it still returns GBP. The value however is calculated according to the power usage and the tariff price set in the settings page, which seems to be correct.

getForecast

Gets the estimated power usage for the specified period.

Url : https://engage.efergy.com/mobile_proxy
Function : getForecast
Parameters :

Example :

https://engage.efergy.com/mobile_proxy/getForecast?token=token&offset=2&period=day

Result :

{"day_kwh":{"estimate":2.72}}

The duration are the number of seconds over which are included in the summation.

getHouseholdDataReference

Gets the reference for the values that are returned by getHoushold.

Url : https://engage.efergy.com/mobile_proxy
Function : getHouseholdDataReference

Example:

https://engage.efergy.com/mobile_proxy/getHouseholdDataReference?token=token

Result :

{
"profileoptions": {
    "ageOfProperty": {
        "desc": "Age of Property",
        "values": [
            {
                "key": "Pre 1851",
                "value": 1
            },
          ...
        ]
    },
    "typeOfProperty": {
        "desc": "Type Of Property",
        "values": [
            {
                "key": "Flat/Maisonette",
                "value": 9
            },
            ...
        ]
    },
    "numOfBedrooms": {
        "desc": "Number of Bedrooms",
        "values": [
            {
                "key": "One",
                "value": 15
            },
            ...
        ]
    },
    "numOfAdults": {
        "desc": "Number of Adults",
        "values": [
            {
                "key": "One",
                "value": 20
            },
            ...
        ]
    },
    "numOfChildren": {
        "desc": "Number of Children",
        "values": [
            {
                "key": "None",
                "value": 43
            },
            ...
        ]
    },
    "typeOfHeating": {
        "desc": "Type of Heating",
        "values": [
            {
                "key": "Gas Central Heating",
                "value": 28
            },
           ...
        ]
    },
    "typeOfHotWater": {
        "desc": "Type of Hot Water",
        "values": [
            {
                "key": "Gas Boiler",
                "value": 32
            },
            ...
        ]
    },
    "typeOfCooker": {
        "desc": "Type of Cooker",
        "values": [
            {
                "key": "Gas Oven and Hob",
                "value": 37
            },
           ...
        ]
    }
}
}

getHousehold

Get the information that is configured in the household attributes section of the settings.

Url : https://engage.efergy.com/mobile_proxy
Function : getHousehold
Example :

https://engage.efergy.com/mobile_proxy/getHousehold?token=token

Result :

{
     "ageOfProperty":"1",
    "typeOfProperty":"9",
    "numOfBedrooms":"15",
    "numOfAdults":"20",
    "numOfChildren":"43",
    "typeOfHeating":"28",
    "typeOfHotWater":"32",
    "typeOfCooker":"37"
}

See also :

comments powered by Disqus