Status

The status endpoint will return a JSON response that will include statistics for every eSite installation registered to the companies account associated with the apikey submitted in the header.

Retrieving the status

Remember: You must include your apikey in the Authorization section of the Header!

Status of all installations

get

Based upon the apiKey, this endpoint will return a JSON object for all installations registered to the users company account

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Responses

200

OK

application/json

401

Unauthorized

5XX

Unknown server error

get

/status

HTTPcURLJavaScriptPython

GET /v1/status HTTP/1.1
Host: api.illumience.com
Authorization: YOUR_API_KEY
Accept: */*

[]

Note: A 200 response will return a JSON object listing all the sites registered to your corporate accout along with some statistics for each site.

Example JSON response array of objects:

[
    {
        "context": string,                  
        "siteId": string,
        "siteName": string,
        "alertLevel": integer,
        "loadStatus": integer,
        "systemMode": integer,
        "totalConsumedPower": double,
        "consumedCurrent": double,
        "t1Power": double,
        "t1Current": double,
        "t2Power": double,
        "t2Current": double,
        "t3Power": double,
        "t3Current": double,
        "gensetPower":, double,
        "gridPower": double,
        "gridCurrent": double,
        "solarPower": double,
        "solarCurrent": double,
        "systemVoltage": double,
        "batterySoc": double,
        "batteryVoltage": double,
        "batteryChargeCurrent": double,
        "batteryState": integer,
        "gensetState": integer,
        "timestamp": integer,
        "connectionStatus": integer,
        "dataAge": integer
    }
]

Field descriptions & default values

Field	Description	Default Value
context	Site ID (as a path)	null
siteId	Site ID	null
siteName	Site name	null
alertLevel	Alert level	0
loadStatus	Load status	0 - connected (default) 1 - low priority load disconnect 10 - high priority load disconnect 11 - disconnected
systemMode	System mode	0 - unknown (default) 1 - auto 2 - auto full charge 3 - manual 4 - safe mode
totalConsumedPower	Total consumed power (W)	0.0
consumedCurrent	Total consumed current (A)	0.0
t1Power	T1 power (W)	null
t1Current	T1 current (A)	null
t2Power	T2 power (W)	null
t2Current	T2 current (A)	null
t3Power	T3 power (W)	null
t3Current	T3 current (A)	null
gensetPower	Genset power (W)	0.0
gridPower	Grid power (W)	null
gridCurrent	Grid current (A)	null
solarPower	Solar power (W)	0.0
solarCurrent	Total solar current (A)	0.0
systemVoltage	System voltage (VDC)	0.0
batterySoc	Battery SoC (%)	0.0
batteryVoltage	Battery voltage (VDC)	0.0
batteryChargeCurrent	Battery charge current (A)	0.0
batteryState	Battery state	0 - unknown (default) 1 - discharge 2 - charge 3 - absorb 4 - equalize 5 - fully charged 6 - unknown 7 - unknown
gensetState	Genset state	0 - off 1 - not starting 2 - forced on 3 - running 4 - not starting 8 - forced on 12 - running 16 - off 17 - not starting (1) (default) 18 - forced on (1) 19 - running (1) 20 - not starting (2) 24 - forced on (2) 28 - running (2) 30 - running (1+2)
timestamp	Unixtime timestamp	0
connectionStatus	Connection status	null - unknown 0 - offline (default) 1 - online 2 - suspended 3 - unknown
dataAge	Data age	0