Eliq Insights API
The Eliq Insights API delivers analytics and presentation-ready data for end-user energy applications. It exposes consumption aggregates by day, week, month, and year, trends, cost, CO2 footprint, day-ahead pricing, weather, peak power, tariff comparisons, PV disaggregation, forecasting, anomalies, and budget or goal tracking. Device-specific energy insights use NILM disaggregation to attribute consumption to appliances.
Eliq Insights API is one of 4 APIs that Eliq publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Insights, Analytics, Energy, Utilities, and Disaggregation. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and an API reference.
This API exposes 57 operations across 49 paths, organized into 17 resource areas, and defines 116 schemas. It is described by OpenAPI 3.1.0, at version 3.4.1.
Requests are made against a single base URL, https://eliq.insights-api.eliq.com.
57 operations
49 paths
116 schemas
2 DELETE45 GET3 PATCH4 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Eliq Insights API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
By default, every request must be authenticated.
BearerAuth— The Eliq insights API uses bearer tokens to authenticate requests. Read more under Authentication tag.
Paths & Operations 57
Across 49 paths, the API surfaces 57 operations — 2 DELETE, 45 GET, 3 PATCH, 4 POST, 3 PUT. They span 17 resource areas, including Users, Locations, Location Profile, Home Profile, Market Price, Breakdown, Energy Usage Categories, Energy Performance Certificate, and 9 more. Each is listed below with its method, path, parameters, and response codes.
Users 6
GET
/v3/users/{userId}
Get user by Eliq internal ID
GET
/v3/users/{userId}/consents
Get User Consents
PUT
/v3/users/{userId}/consents
Update User Consents
GET
/v3/users
Get user by Eliq external reference
GET
/v3/Users/{userId}/locations
Get user locations
GET
/v3/Users/{userId}/sent_notifications
Get user sent notifications.
Locations 10
GET
/v3/locations/{locationId}
Get location by internal id
GET
/v3/locations
Get location by Eliq external reference
GET
/v3/locations/{locationId}/notifications
Get location Notifications
GET
/v3/locations/{locationId}/notifications/settings
Get Location Notifications Settings
PUT
/v3/locations/{locationId}/notifications/settings/{notificationTypeId}
Update notification settings per location.
GET
/v3/locations/{locationId}/yearly_estimates
Get locations manual Annual Consumption values
POST
/v3/locations/{locationId}/yearly_estimates
Post locations manual Annual Consumption values
DELETE
/v3/locations/{locationId}/yearly_estimates
Delete locations manual Annual Consumption Value
GET
/v3/locations/{locationId}/yearly_estimates/suggestion
Get location Annual Consumption Suggestion
GET
/v3/locations/{locationId}/temperature
Get temperature
Location Profile 7
GET
/v3/locations/{locationId}/profile/type
Get location profile type
POST
/v3/locations/{locationId}/profile/type
Set location profile type
GET
/v3/locations/{locationId}/profile
Get location profile
POST
/v3/locations/{locationId}/profile
Add new location profile values
GET
/v3/locations/{locationId}/profile/completion
Get location profile completion percentage
PATCH
/v3/locations/{locationId}/profile/{profileValueId}
Patch location profile's value
DELETE
/v3/locations/{locationId}/profile/{profileValueId}
Delete location profile's value
Home Profile 3
GET
/v3/locations/{locationId}/homeprofiledeprecated
Get location homeprofile
PATCH
/v3/locations/{locationId}/homeprofiledeprecated
Update home profile
GET
/v3/locations/{locationId}/homeprofile/completiondeprecated
Get location homeprofile completion
Market Price 2
GET
/v3/locations/{locationId}/marketprice/prices
Get location market prices
GET
/v3/locations/{locationId}/marketprice/price-summary
Get location market price summary
Breakdown 1
GET
/v3/locations/{locationId}/breakdowndeprecated
Get location energy usage breakdown
Energy Usage Categories 1
GET
/v3/locations/{locationId}/euc
Get energy usage categories (EUC) for a location
Energy Performance Certificate 1
GET
/v3/locations/{locationId}/epc-rating
Get EPC rating
Energy Data 8
GET
/v3/locations/{locationId}/consumption
Get Location consumption
GET
/v3/locations/{locationId}/peakpower/{resolution}
Get location peak power
GET
/v3/locations/{locationId}/production
Get location production
GET
/v3/locations/{locationId}/import
Get location import
GET
/v3/locations/{locationId}/export
Get location export
GET
/v3/locations/{locationId}/forecast
Get location forecast
GET
/v3/locations/{locationId}/forecast/hourly
Get location forecast hourly
GET
/v3/meters/{meterId}/energy
Get meter energy data
Price Formulas 1
GET
/v3/locations/{locationId}/price-formula
Get price formulas
Similar Homes 3
GET
/v3/locations/{locationId}/similarhomes
Get similar homes group
GET
/v3/locations/{locationId}/similarhomes/consumption
Get similar homes consumption
GET
/v3/locations/{locationId}/similarhomes/report
Get similar homes report
Budgets 3
GET
/v3/locations/{locationId}/budgets
Get location budgets
PUT
/v3/locations/{locationId}/budgets
Update location budgets
GET
/v3/locations/{locationId}/budgets/history
Get location budget history
Advice 3
GET
/v3/locations/{locationId}/advice
Get advice
PATCH
/v3/locations/{locationId}/advice/{adviceId}
Patch advice
GET
/v3/locations/{locationId}/advice/estimated-savings-monetary-source
Get savings monetary sources
Anomalies 1
GET
/v3/locations/{locationId}/anomalies
Get anomalies
Health 1
GET
/v3/health/heart_beat
Get heart beat
Eliq Connect 4
GET
/v3/users/{userId}/connections/web-portal-uri
Get Eliq Connect Web URI
GET
/v3/users/{userId}/connections
Get User Connections
GET
/v3/connections/{connectionId}/connection-entities
Get connection entities
GET
/v3/locations/{locationId}/connection-meta-data
Get location connection meta data
Authentication 2
POST
/v3/auth/user/token
POST User token request
GET
/v3/authentication/autologin/ticket
GET Autologin ticket
Schemas 116
The contract defines 116 schemas that model the data the API accepts and returns. The most detailed are Advice (18 properties), TimeSeriesData (13 properties), PeakPowerResponse (12 properties), LocationMeter (12 properties). Each schema is shown below with its type and property counts.
Address
object
General address data including latitude and longitude.
6 properties
2 required
User
object
Get user information
9 properties
3 required
Consent
object
9 properties
Location
object
Location data.
7 properties
6 required
LocationFuel
object
Fuel data
4 properties
LocationFuelItem
object
General data about a fuel item.
5 properties
2 required
SyncStatus
string
Data synchronization status.
LocationFuels
object
Available fuel data
3 properties
LocationMeter
object
Meter data.
12 properties
5 required
NotificationSettingsResponse
object
8 properties
Homeprofile
object
The home profile is describing the properties of a location, such as house type, heating system and other appliances. This information is later used in Eliq an…
5 properties
Fuel
string
Fuel type
FuelSource
string
Source of fuel data.
LimitRange
object
Available if type is 'limitrange'. Contains minimum and maximum values for the given key.
2 properties
2 required
HomeProfileOption
object
A home profile option is the option that can be set. A home profile option may have different data types, 'singleselect', 'multipleselect' or 'number'. The ava…
10 properties
2 required
MarketPriceElementDto
object
2 properties
2 required
MarketPriceResolution
string
PriceLevel
string
MarketPriceSummaryElementDto
object
6 properties
6 required
MarketPriceSummaryDto
object
5 properties
5 required
PatchDocument
array
Patch document used in patch operations
Breakdown
object
The breakdown model contains information about the location breakdown (aka. Energy usage categories (EUC)).
6 properties
6 required
BreakdownItem
object
Breakdown item contain usage information for a specific usage category
2 properties
2 required
ResultWrapper
object
Responses from the similar homes and breakdown endpoint are wrapped in an object called result wrapper. The result status will contain information about the re…
2 properties
1 required
TimeseriesData
object
Model containing time series data. Different parameters will be available depending on the data requested, see below for more information
10 properties
5 required
MeterDataResult
object
Model containing meter time series data result. Different parameters will be available depending on the data requested, see below for more information
6 properties
6 required
YearlyEstimate
object
Model containing yearly estimate for a location
5 properties
4 required
TemperatureData
object
Model containing time series temperature data. Different parameters will be available depending on the data requested, see below for more information
4 properties
3 required
SimilarHomesGroup
object
Description of similar homes that a location is compared to.
2 properties
2 required
SimilarHomesGroupFilter
object
Similar homes group filter.
5 properties
3 required
SimilarHomesGroupFilterType
string
Describes whether 'limitvalues' or 'limitrange' should be used.
SimilarHomesGroupResultModel
object
Model containing similar homes group result.
2 properties
1 required
SimilarHomesResultStatus
object
Contains information about the result, and whether it was successful or not.
2 properties
1 required
SimilarHomesResultStatusAction
object
Available in cases where there are actions that can be done to make the result successful, such as entering information in the home profile options.
2 properties
MeterPriceFormula
object
8 properties
Source
string
Price formula source
Element
object
4 properties
2 required
PriceElementType
string
Formula element type.
PriceFormulaDirection
string
Direction type
Charge
object
Object containing the charge. Available when type is set to charge.
2 properties
1 required
ChargeResolution
string
Charge resolution
UnitRate
object
Object containing the unit rate. Available when type is set to unitrate.
7 properties
1 required
UnitRateType
string
Unit rate type
Fixed
object
Object containing spot price information. Available if unit rate type is set to 'fixed'
1 property
1 required
Nordpool
object
Object containing Nordpool information. Available if unit rate type is set to nordpool
3 properties
2 required
NordpoolResolution
string
Tou
object
4 properties
Interval
object
2 properties
Block
object
7 properties
BlockResolution
string
SpotPrice
object
4 properties
SpotPriceProvider
string
SpotPriceResolution
string
TimeSeriesData
object
13 properties
Co2Emission
object
2 properties
FuelType
string
UnitType
string
SimilarHomesResultStatusCode
string
Indicating whether there is a result or not.
Budget
object
Model for budget. Contains information about the budget, and when it last was run.
10 properties
5 required
BudgetHistory
object
Past budget periods for a location as aligned time series. Each index in limit and consumption corresponds to one period between from and to at resolution.
7 properties
7 required
Advice
object
Model containing advice information.
18 properties
6 required
AdviceFinancingOptionModel
object
Financing option
5 properties
5 required
EstimatedSavings
object
The estimated energy savings in either kWh or M3 for a given advice. Unit depends on whether the advice is intended for gas of electricity.
2 properties
2 required
AdviceLinkModel
object
Optional link which can be included with each advice
4 properties
3 required
AdviceLinkType
string
The type which can be set to an advice Link.
EnergyUnit
string
FinancingOptionType
string
Financing option type
AdvicePatchInput
object
Advice status update request body
3 properties
3 required
AdviceStatus
string
This statuses are used to capture end user feedback and feed this information back to our algorithms as well as making it easy to build an UI. The status can b…
AdviceType
string
Advice type is used as a sub-category or a group
Direction
string
Direction type
EUC
object
Model containing energy usage by category
6 properties
6 required
EpcRatingResponse
object
EPC rating
6 properties
3 required
EpcRatingStatus
string
Current energy rating status based on the valid from and to dates Not available for estimated energy rating type
EpcRatingType
string
Energy rating type
Error
object
Model returned for error responses.
6 properties
EucCategoryResultModel
object
Energy usage by category
3 properties
3 required
EucAccuracy
string
Result data accuracy
Link
object
Optional link can be included with each advice Deprecated property, links should be used instead.
2 properties
2 required
AdviceInvestmentCostModel
object
Investment cost
4 properties
AdviceReturnOfInvestmentModel
object
Return of investment
3 properties
3 required
AdviceReturnOfInvestmentUnit
string
Return of investment unit
SavingMonetary
object
Savings monetary value
3 properties
3 required
SavingMonetarySource
object
Savings calculation source type
3 properties
3 required
SimilarHomesConsumptionResultModel
object
Model containing similar homes consumption result.
2 properties
1 required
SimilarHomesConsumption
object
Similar homes consumption data.
7 properties
5 required
SimilarHomesResolutionType
string
Matches with the value passed in query parameters of the request.
SimilarHomesFuelType
string
Matches with the value passed in query parameters of the request, or a default value.
SimilarHomesUnitType
string
Matches with the value passed in query parameters of the request, or a default value.
SimilarHomesReportResultModel
object
Model containing similar homes report result.
2 properties
1 required
SimilarHomesReport
object
Similar homes report for the requested period.
6 properties
4 required
Anomaly
object
Anomaly object
3 properties
3 required
Notification
object
Notification object. Content available in "object" is dependent on the notification type.
7 properties
6 required
MarketPriceResponseDto
object
5 properties
5 required
PeakPowerResponse
object
Peak power response model
12 properties
8 required
PatchLocationProfileRequestModel
object
2 properties
LocationProfileType
object
1 property
1 required
ProfileType
string
Profile type
LocationNotificationSettingsInput
object
The various settings which can be configured for a notification. An important note is that the notification is sent via all configured channels. I.E. if none o…
6 properties
1 required
LocationProfileCompletionResponse
object
1 property
1 required
LocationProfileDataType
string
Data type
LocationProfilePossibleValue
object
A possible value for a location profile setting. Available when the specified datatype is singleselect or multipleselect.
2 properties
2 required
LocationProfileSelectedValue
object
Selected value with metadata
3 properties
2 required
LocationProfileSetting
object
Location profile key setting
9 properties
5 required
LocationProfileSettings
object
2 properties
2 required
LocationProfileTag
string
Tag for location profile
LocationProfileValueRequest
object
Location profile value input
3 properties
2 required
LocationProfileValueResponse
object
Location profile value result
4 properties
3 required
LocationPropertyLimit
object
Limitations set for profile setting values. Available when the specified datatype is number.
3 properties
3 required
LocationPropertyRequirement
object
Properties that are required for a setting to be valid.
2 properties
Connection
object
4 properties
ConnectionEntity
object
5 properties
ConnectionMetaData
object
1 property
EliqConnectUriResponse
object
1 property
UserNotification
object
6 properties
Event
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Eliq 3
Other APIs Eliq publishes across the network.
Eliq Auth API
Eliq Data Management API
Eliq Intelligence API
#Insights#Analytics#Energy#Utilities#Disaggregation
Where this information came from
This is an independent, third-party profile of Eliq Insights API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.