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 Similar Homes API

The Similar Homes API from Eliq — 3 operation(s) for similar homes.

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

Tagged areas include Similar Homes. 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 16 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 16 schemas 3 GET

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 Similar Homes 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 — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Similar Homes 3
GET
/v3/locations/{locationId}/similarhomes
Get similar homes group
get-v3-locations-locationId-similarhomes 1 param → 200404500
GET
/v3/locations/{locationId}/similarhomes/consumption
Get similar homes consumption
get-v3-locations-locationId-similarhomes-consumption 6 params → 200400404500
GET
/v3/locations/{locationId}/similarhomes/report
Get similar homes report
get-v3-locations-locationId-similarhomes-report 5 params → 200400404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are SimilarHomesConsumption (7 properties), Error (6 properties), SimilarHomesReport (6 properties), SimilarHomesGroupFilter (5 properties). Each schema is shown below with its type and property counts.

SimilarHomesConsumption
object
Similar homes consumption data.
7 properties 5 required
SimilarHomesGroupFilterType
string
Describes whether 'limitvalues' or 'limitrange' should be used.
SimilarHomesFuelType
string
Matches with the value passed in query parameters of the request, or a default value.
SimilarHomesResultStatusCode
string
Indicating whether there is a result or not.
SimilarHomesGroup
object
Description of similar homes that a location is compared to.
2 properties 2 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
SimilarHomesReportResultModel
object
Model containing similar homes report result.
2 properties 1 required
Error
object
Model returned for error responses.
6 properties
LimitRange
object
Available if type is 'limitrange'. Contains minimum and maximum values for the given key.
2 properties 2 required
SimilarHomesReport
object
Similar homes report for the requested period.
6 properties 4 required
SimilarHomesResultStatus
object
Contains information about the result, and whether it was successful or not.
2 properties 1 required
SimilarHomesConsumptionResultModel
object
Model containing similar homes consumption result.
2 properties 1 required
SimilarHomesGroupFilter
object
Similar homes group filter.
5 properties 3 required
SimilarHomesUnitType
string
Matches with the value passed in query parameters of the request, or a default value.
SimilarHomesResolutionType
string
Matches with the value passed in query parameters of the request.
SimilarHomesGroupResultModel
object
Model containing similar homes group result.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eliq-similar-homes-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 Similar Homes 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.