How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Eliq Advice API

The Advice API from Eliq — 3 operation(s) for advice.

Eliq Advice API is one of 39 APIs that Eliq publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Advice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 3 operations across 3 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 3.4.1.

Requests are made against a single base URL, http://localhost:3000.

3 operations 3 paths 17 schemas 2 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.4.1
Base URL
https://auth-api.eliq.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Eliq Advice 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 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Advice 3
GET
/v3/locations/{locationId}/advice
Get advice
get-v3-location-advice 3 params → 200404500
PATCH
/v3/locations/{locationId}/advice/{adviceId}
Patch advice
patch-v3-location-advice-adviceId 2 params body → 200400404500
GET
/v3/locations/{locationId}/advice/estimated-savings-monetary-source
Get savings monetary sources
get-v3-location-advice-monetary-sources 1 param → 200404500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Advice (18 properties), Error (6 properties), AdviceFinancingOptionModel (5 properties), AdviceInvestmentCostModel (4 properties). Each schema is shown below with its type and property counts.

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…
Link
object
Optional link can be included with each advice Deprecated property, links should be used instead.
2 properties 2 required
AdviceReturnOfInvestmentUnit
string
Return of investment unit
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
AdviceInvestmentCostModel
object
Investment cost
4 properties
AdviceType
string
Advice type is used as a sub-category or a group
SavingMonetary
object
Savings monetary value
3 properties 3 required
FinancingOptionType
string
Financing option type
Advice
object
Model containing advice information.
18 properties 6 required
Error
object
Model returned for error responses.
6 properties
AdviceLinkType
string
The type which can be set to an advice Link.
SavingMonetarySource
object
Savings calculation source type
3 properties 3 required
EnergyUnit
string
AdviceLinkModel
object
Optional link which can be included with each advice
4 properties 3 required
AdviceReturnOfInvestmentModel
object
Return of investment
3 properties 3 required
AdviceFinancingOptionModel
object
Financing option
5 properties 5 required
AdvicePatchInput
object
Advice status update request body
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eliq-advice-api-openapi.yml Raw ↑

Other APIs Eliq publishes across the network.

Eliq Anomalies API
Eliq Authentication API
Eliq Breakdown API
Eliq Budgets API
Eliq Client details API
Eliq Dashboards API
Eliq Eliq Connect API
Eliq Energy Data API
Eliq Energy Performance Certificate API
Eliq Energy Usage Categories API
Eliq Health API
Eliq Home Profile API
Where this information came from

This is an independent, third-party profile of Eliq Advice 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.