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 Locations API

The Locations API from Eliq — 8 operation(s) for locations.

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

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

This API exposes 10 operations across 8 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.

10 operations 8 paths 16 schemas 1 DELETE7 GET1 POST1 PUT

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 Locations 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 10

Across 8 paths, the API surfaces 10 operations — 1 DELETE, 7 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Locations 10
GET
/v3/locations/{locationId}
Get location by internal id
get-v3-locations-locationId 1 param → 200404500
GET
/v3/locations
Get location by Eliq external reference
get-v3-locations-locationExtref 1 param → 200400404500
GET
/v3/locations/{locationId}/notifications
Get location Notifications
get-v3-locations-notification 1 param → 200404
GET
/v3/locations/{locationId}/notifications/settings
Get Location Notifications Settings
get-v3-locations-notification-settings 1 param → 200404
PUT
/v3/locations/{locationId}/notifications/settings/{notificationTypeId}
Update notification settings per location
put-v3-locations-locationId-notifications-settings 2 params body → 200400404500
GET
/v3/locations/{locationId}/yearly_estimates
Get locations manual Annual Consumption values
get-v3-locations-locationId-yearly_estimates 5 params → 200400404
POST
/v3/locations/{locationId}/yearly_estimates
Post locations manual Annual Consumption values
post-v3-locations-locationId-yearly_estimates 1 param body → 200400404
DELETE
/v3/locations/{locationId}/yearly_estimates
Delete locations manual Annual Consumption Value
delete-v3-locations-locationId-yearly_estimates 4 params → 204400404500
GET
/v3/locations/{locationId}/yearly_estimates/suggestion
Get location Annual Consumption Suggestion
get-v3-locations-locationId-consumption/suggestion 3 params → 200400
GET
/v3/locations/{locationId}/temperature
Get temperature
get-v3-location-temperature 4 params → 200400

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are LocationMeter (12 properties), NotificationSettingsResponse (8 properties), Notification (7 properties), Location (7 properties). Each schema is shown below with its type and property counts.

Notification
object
Notification object. Content available in "object" is dependent on the notification type.
7 properties 6 required
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
LocationMeter
object
Meter data.
12 properties 5 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
Fuel
string
Fuel type
LocationFuels
object
Available fuel data
3 properties
LocationFuelItem
object
General data about a fuel item.
5 properties 2 required
FuelSource
string
Source of fuel data.
LocationFuel
object
Fuel data
4 properties
Error
object
Model returned for error responses.
6 properties
NotificationSettingsResponse
object
8 properties
SyncStatus
string
Data synchronization status.
Location
object
Location data.
7 properties 6 required
Address
object
General address data including latitude and longitude.
6 properties 2 required
YearlyEstimate
object
Model containing yearly estimate for a location
5 properties 4 required
Direction
string
Direction type

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eliq-locations-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 Locations 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.