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 Data Management API

The Eliq Data Management API ingests and manages customer, location, and meter data inside the Eliq system. Clients use it to provision users and locations, post energy consumption readings, attach metadata such as tariffs and dwelling information, and keep the dataset that powers the Insights API up to date.

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

Tagged areas include Data Management, Energy, and Utilities. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and an API reference.

This API exposes 78 operations across 43 paths, organized into 18 resource areas, and defines 61 schemas. It is described by OpenAPI 3.0.1, at version 1.5.2.

Requests are made against a single base URL, https://eliq.data-management-api.eliq.com/integration/api/v1.

78 operations 43 paths 61 schemas 20 DELETE36 GET1 PATCH14 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.5.2
Base URL
https://eliq.data-management-api.eliq.com/integration/api/v1
Contact
Resource Areas
18

Paths & Operations 78

Across 43 paths, the API surfaces 78 operations — 20 DELETE, 36 GET, 1 PATCH, 14 POST, 7 PUT. They span 18 resource areas, including Client details, Jobs, Location price formulas, Location profile, Location, Location home profile, Meter Price Formulas, Meter, and 10 more. Each is listed below with its method, path, parameters, and response codes.

Client details 1
GET
/client-details/available-languages
Gets available languages for the users
get-availablelanguages → 200409500
Jobs 8
POST
/jobs/{entity}/{operation}
Create job based on entity and operation and provided file
create-job 2 params → 200400404500
GET
/jobs/{jobId}/cancel
Cancel job before it is finished by job id
cancel-job 1 param → 202400500
GET
/jobs
Get jobs based on job state, id or name reference.
get-jobs 4 params → 200400500
GET
/jobs/{jobId}
Get Job details by job id
get-job 1 param → 200404500
GET
/jobs/{jobId}/failures
Get errors and details from job.
get-job-failures 3 params → 200404500
GET
/jobs/{jobId}/content
Get Job content - the .ndjson file provided as the input when the Job was created.
get-job-content 1 param → 200404500
GET
/jobs/{jobId}/result
Get Job result. Export include result object containing exported details.
get-job-result 1 param → 200404500
GET
/jobs/{jobId}/result/{page}
Get Job result. Export include result object containing exported details.
get-job-result-page 2 params → 200404500
Location price formulas 4
GET
/locations/{locationId}/priceformulas
Get location price formulas
get-locations-locationId-priceformulas 3 params → 200400404500
POST
/locations/{locationId}/priceformulas
Create or updates a location price formula
post-locations-locationId-priceformulas 1 param body → 200400404500
DELETE
/locations/{locationId}/priceformulas
Delete specific location price formula
delete-locations-locationId-priceformulas 4 params → 204400404500
DELETE
/locations/{locationId}/priceformulas/all
Delete location all price formulas
delete-locations-all-priceformulas 1 param → 204400404500
Location profile 6
POST
/locations/{locationId}/profile/type
Set location profile type
set-locations-locationId-profile-type 1 param body → 200400404500
GET
/locations/{locationId}/profile/type
Get location profile type
get-locations-locationId-profile-type 1 param → 200400404500
POST
/locations/{locationId}/profile
Set location profile values
set-locations-locationId-profile-values 1 param body → 200400404500
GET
/locations/{locationId}/profile
Get location profile
get-locations-locationId-profile 1 param → 200400404500
PATCH
/locations/{locationId}/profile/{id}
Patch location profile value
patch-locations-locationId-profile-value 2 params body → 200400404500
DELETE
/locations/{locationId}/profile/{id}
Delete location profile
delete-locations-locationId-profile 2 params → 204400404500
Location 5
PUT
/locations/{id}
Creates or updates location
put-locations-locationId 1 param body → 200400500
DELETE
/locations/{id}
Deletes location
delete-locations-locationId 1 param → 200400500
GET
/locations/{id}
Gets location
get-locations-locationId 1 param → 200400500
GET
/locations
Gets multiple locations
get-locations 3 params → 200400500
GET
/locations/{id}/meters
Gets location meters
get-locations-locationId-meters 1 param → 200400500
Location home profile 4
GET
/locations/{locationId}/homeprofiledeprecated
Get a location home profile
get-locations-locationId-homeprofile 1 param → 200400404500
PUT
/locations/{locationId}/homeprofiledeprecated
Create a home profile for location
put-locations-locationId-homeprofile 1 param body → 200201400404500
DELETE
/locations/{locationId}/homeprofiledeprecated
Delete all location home profile elements
delete-locations-locationId-homeprofile 1 param → 204400404500
POST
/locations/{locationId}/homeprofiledeprecated
Update a property of location home profile
post-locations-locationId-homeprofile 1 param body → 204400404500
Meter Price Formulas 4
GET
/meters/{meterId}/priceformulas
Get price formulas for a meter by meter external reference.
get-meter-meterid-price-formulas 1 param → 200400404500
POST
/meters/{meterId}/priceformulas
Add or update a price formula for a meter by meter external reference.
add-or-update-meter-price-formulas 1 param body → 200400500
DELETE
/meters/{meterId}/priceformulas/{fromDate}
Delete a price formulas for a meter by meter external reference and older than specified date.
delete-meter-from-date-price-formulas 2 params → 204400404500
DELETE
/meters/{meterId}/priceformulas/all
Delete all price formulas for a meter specified by meter external reference.
delete-meter-all-price-formulas 1 param → 204400404500
Meter 4
PUT
/meters/{id}
Creates or updates a meter.
put-meter-meterid 1 param body → 200201400404500
GET
/meters/{id}
Gets a meter by provided meter external reference.
get-meter-meterid 1 param → 200400404500
DELETE
/meters/{id}
Deletes a meter by provided meter external reference.
delete-meter-meterid 1 param → 204400404500
GET
/meters
Gets a list of meters based on the provided query parameters.
get-meters 3 params → 200404500
Meter Energy Day 3
POST
/meters/{id}/energy/day
Creates or updates daily energy data for a meter.
post-daily-energy-meterid 1 param body → 204400404500
DELETE
/meters/{id}/energy/day
Deletes the daily energy data for a meter.
delete-daily-energy-meterid 5 params → 204400404500
GET
/meters/{id}/energy/day
Gets the stored daily energy data for a meter within a specified timespan.
get-daily-energy-meterid 5 params → 200400404500
Meter Energy High Resolution 4
POST
/meters/{id}/energy/highres/{resolution}
Creates or updates high resolution (hourly or higher) energy data for a meter.
post-high-resolution-energy-meterid 2 params body → 204400404500
DELETE
/meters/{id}/energy/highres/{resolution}
Deletes the high resolution (hourly or higher) energy data for a meter.
delete-high-resolution-energy-meterid-2 6 params → 204400404500
GET
/meters/{id}/energy/highres/{resolution}
Gets the stored high resolution (hour or higher) energy data for a meter within a specified timespan.
get-high-resolution-energy-meterid 6 params → 200400404500
DELETE
/meters/{id}/energy/{resolution}
Deletes the high resolution (hourly or higher) energy data for a meter.
delete-high-resolution-energy-meterid 6 params → 204400404500
Meter Energy Reads 3
POST
/meters/{id}/reads
Creates or updates meter reads for a meter.
post-meter-reads-meterid 1 param body → 204400404500
GET
/meters/{id}/reads
Gets the stored meter reads for a meter within a specified timespan.
get-meter-reads-meterid 5 params → 200400404500
DELETE
/meters/{id}/reads
Deletes the stored meter reads for a meter within a specified timespan.
delete-meter-reads-meterid 5 params → 204400404500
Meter Energy Period 3
POST
/meters/{id}/energy/period
Creates or updates periodic (monthly or higher) energy data for a meter.
post-period-energy-data-meterid 1 param body → 204400404500
GET
/meters/{id}/energy/period
Gets the stored periodic (monthly or higher) energy data for a meter within a specified timespan.
get-period-energy-data-meterid 5 params → 200400404500
DELETE
/meters/{id}/energy/period
Deletes the stored periodic (monthly or higher) energy data for a meter within a specified timespan.
delete-period-energy-data-meterid 5 params → 204400404500
Meter Max Demand 6
POST
/meters/{id}/max-demand/{resolution}
Creates or updates max demand (peak power) data for a meter with a specified resolution.
post-max-demand-meterid 2 params body → 204400404500
GET
/meters/{id}/max-demand/{resolution}
Gets the stored max demand (peak power) data for a meter with a specified resolution within a specified time frame.
get-max-demand-meterid 5 params → 200400404500
DELETE
/meters/{id}/max-demand/{resolution}
Deletes the max demand (peak power) data for a meter with a specified resolution within a specified time frame.
delete-max-demand-meterid 5 params → 204400404500
DELETE
/meters/{id}/max-demand/limits/{resolution}
Deletes the max demand (peak power) limits for a meter with a specified resolution and unit.
delete-max-demand-limit-meterid 3 params → 204400404500
POST
/meters/{id}/max-demand/limits/{resolution}
Creates or updates the max demand (peak power) limits for a meter with a specified resolution and unit.
post-max-demand-limit-meterid 2 params body → 204400404500
GET
/meters/{id}/max-demand/limits/{resolution}
Gets the max demand (peak power) limits for a meter with a specified resolution and unit.
get-max-demand-limit-meterid 3 params → 200400404500
Portfolio Accounts 5
PUT
/portfolio/accounts/{id}
Create or update portfolio account
put-portfolio-accounts 1 param body → 200201400
DELETE
/portfolio/accounts/{id}
Delete a portfolio account
delete-portfolio-accounts 1 param → 204400404
GET
/portfolio/accounts/{id}
Get portfolio account
get-portfolio-accounts 1 param → 200400404
GET
/portfolio/accounts/name/{name}
Get portfolio account, by name
get-portfolio-accounts-by-name 1 param → 200400404
GET
/portfolio/accounts
Get all portfolio accounts
get-portfolio-accounts-list → 200
Portfolio Groups 4
POST
/portfolio/accounts/{accountId}/groups
Create (update not allowed) portfolio group
put-portfolio-groups 1 param body → 201400404
GET
/portfolio/accounts/{accountId}/groups
Get all groups on porfolio account
get-portfolio-groups-list 1 param → 200400404
DELETE
/portfolio/accounts/{accountId}/groups/{id}
Delete group on portfolio account
delete-portfolio-groups 2 params → 204400403404
GET
/portfolio/accounts/{accountId}/groups/{id}
Get group on portfolio account
get-portfolio-groups 2 params → 200400404
Portfolio Locations 4
PUT
/portfolio/accounts/{accountId}/locations/{id}
Create or update portfolio location
put-portfolio-locations 2 params body → 200201400404
DELETE
/portfolio/accounts/{accountId}/locations/{id}
Remove location from portfolio account
delete-portfolio-locations 2 params → 204400404
GET
/portfolio/accounts/{accountId}/locations/{id}
Get location on portfolio account
get-portfolio-locations 2 params → 200400404
GET
/portfolio/accounts/{accountId}/locations
Get all locations on porfolio account
get-portfolio-locations-list 1 param → 200400404
Portfolio Users 4
PUT
/portfolio/accounts/{accountId}/users/{id}
Create or update portfolio user
put-portfolio-users 2 params body → 200201400404
DELETE
/portfolio/accounts/{accountId}/users/{id}
Delete user on portfolio account
delete-portfolio-users 2 params → 204400404
GET
/portfolio/accounts/{accountId}/users/{id}
Get user on portfolio account
get-portfolio-users 2 params → 200400404
GET
/portfolio/accounts/{accountId}/users
Get all user on porfolio account
get-portfolio-users-list 1 param → 200400404
User 6
PUT
/users/{id}
Creates or updates user
put-users-userId 1 param body → 200201400500
DELETE
/users/{id}
Deletes user
delete-users-userId 1 param → 200400500
GET
/users/{id}
Gets user
get-users-userId 1 param → 200400500
GET
/users
Gets multiple users
get-users 3 params → 200400500
POST
/users/{id}/notification
Sends notifications to user
post-users-userId-notification 1 param body → 200400500
GET
/users/{id}/locations
Gets user locations
get-users-userId-locations 1 param → 200400500

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are Meter (14 properties), JobEntry (12 properties), Location (10 properties), LocationProfileSetting (9 properties). Each schema is shown below with its type and property counts.

AcceptedResult
object
6 properties
Block
object
7 properties
CapacityTariff
object
3 properties
Charge
object
4 properties
DeviceMaxDemand
object
3 properties
DeviceMaxDemandLimit
object
4 properties
DtoLink
object
3 properties
DtoLinkTarget
string
Element
object
4 properties
EnergyDailyData
object
5 properties
EnergyHighResolutionData
object
4 properties
EnergyMonthlyData
object
8 properties
ErrorDetails
object
3 properties 2 required
FileRowError
object
2 properties
Fixed
object
1 property
HomeProfileProperty
object
3 properties
IOutputFormatter
object
Interval
object
2 properties
JobEntry
object
12 properties
JobEntryStateType
string
JobFailedRow
object
3 properties
JobOperationType
string
JobResultRow
object
4 properties
JobType
string
Location
object
10 properties
LocationAddress
object
4 properties
LocationGeo
object
2 properties
LocationPriceFormula
object
9 properties
LocationProfileDataType
string
LocationProfilePossibleValue
object
2 properties
LocationProfilePropertyRequirement
object
2 properties
LocationProfileSelectedValue
object
3 properties
LocationProfileSetting
object
9 properties 8 required
LocationProfileSettings
object
2 properties 2 required
LocationProfileTag
string
LocationProfileType
object
1 property
LocationProfileValueRequest
object
3 properties 2 required
LocationProfileValueResponse
object
4 properties 2 required
LocationPropertyLimit
object
3 properties
Meter
object
14 properties
NoContentResult
object
1 property
NonSmartMeterReadDto
object
6 properties
NonSmartRegisterDto
object
2 properties
NotificationDto
object
4 properties
NotificationType
string
OkObjectResult
object
5 properties
PatchLocationProfileRequestModel
object
2 properties
PortfolioAccount
object
3 properties 1 required
PortfolioGroup
object
8 properties
PortfolioGroupAddDto
object
3 properties
PortfolioGroupStatus
string
PortfolioLocation
object
3 properties 1 required
PortfolioUser
object
6 properties 2 required
PortfolioUserRole
string
PriceFormula
object
7 properties
ProfileType
string
Register
object
3 properties
SpotPrice
object
4 properties
Tou
object
4 properties
UnitRate
object
6 properties
User
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eliq-data-management-api-openapi.json Raw ↑

Other APIs Eliq publishes across the network.

Eliq Auth API
Eliq Insights API
Eliq Intelligence API
Where this information came from

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