API Eliq Online

With the Eliq Online API you can extract real-time data and historical data from Eliq Online. It is either possible to extract data for your own purpose or to create an application that all users can use.

If you want to use the data yourself, you create a manual access token (unique key) under your API settings. After that you only have to test the example links for each function below. Replace the {access token} in the links with your private access token.

If you are interested in creating an application, please contact us at support(at)eliq.io. The following features will then be available for you to call with a user's access token after this user has joined your application via Open Authentication.

 

Features

Down below all the features are listed. At the end of the document, there is a help section explaining our definitions.

The "channelid" must be included (transmitters). Channelid can be found under My Energy Data in Settings.

Data

Retrieve historical data for a user. There are data per day and at 6-minute intervals. "Enddate" has limitations depending on the range used. There are also different "default values" depending on the interval.

 

Parameters

• startdate
• intervaltype [day/hour/6min]
• accesstoken
• enddate?
• channelid

Results

• channelid
• startdate
• enddate
• intervaltype
• data [list]
  • avgpower [float?]
  • energy [float?]
  • temp_out [float?]
  • time_start [datetime?]
  • time_end [datetime?]

Example

https://my.eliq.io/api/data?accesstoken={access-token}&channelid={channel-id}&startdate=2013-06-01&intervaltype=6min

 

DataNow

Download the latest watt that came in for users

 

Parameters

• accesstoken
• channelid

Results

• channelid
• createddate
• power [float]

Example

https://my.eliq.io/api/datanow?accesstoken={access-token}&channelid={channel-id}

 

Open Authentication

For connecting users to our API, we run OAuth (Open Authentication). Contact us for more information.

 

Help

For some parameters we have added additional information. These mean:

• [] : Describes the limitation of data
• () : Further explanation of parameters
• ?: Any parameter and results, it may sometimes be zero

Date is always "ISO 8601, European" and is based on local time for the user. Any error message will be returned to Content and with the Status Code "400 Bad Request".