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 Home Profile API

The Home Profile API from Eliq — 2 operation(s) for home profile.

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

Tagged areas include Home Profile. 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 2 paths, and defines 4 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 2 paths 4 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 Home Profile 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 2 paths, the API surfaces 3 operations — 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Home Profile 3
GET
/v3/locations/{locationId}/homeprofiledeprecated
Get location homeprofile
get-v3-locations-locationId-homeprofile 1 param → 200404
PATCH
/v3/locations/{locationId}/homeprofiledeprecated
Update home profile
patch-v3-locations-locationId-homeprofile 1 param body → 200404
GET
/v3/locations/{locationId}/homeprofile/completiondeprecated
Get location homeprofile completion
get-v3-locations-locationId-homeprofile-completion 1 param → 200404

Schemas 4

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

PatchDocument
array
Patch document used in patch operations
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
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
Error
object
Model returned for error responses.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eliq-home-profile-api-openapi.yml Raw ↑

Other APIs Eliq publishes across the network.

Eliq Advice API
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
Where this information came from

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