Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/eliq:eliq-meter-energy-high-resolution-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Eliq Data Management Meter Energy High Resolution API
description: '# API Reference
The Eliq data management API is organized around REST. The API accepts JSON-encoded request bodies, returns JSON-encoded responses and uses standard HTTP response codes. The URLs are all resource oriented around Eliq''s three main entities; User, Location and Meter
# Errors
Eliq Integration API uses standard HTTP response codes to indicate success or failure of a request. Codes with 2xx indicate success, 4xx indicate error due to invalid input, and 5xx indicates an error in Eliq Integration API.
## Status codes
*Status code* | *Description*
--- | ---
200 - OK | Everything worked as expected.
201 - Created | Resource created.
202 - Accepted | Successful request, and will be handled later. A reference id will be available in the response body.
204 - No Content | Successful request. Used in successful delete requests
400 - Bad Request | Request input data is invalid.
401 - Unauthorized | Access token invalid for the given request. Eg. access token expired.
404 - Not Found | Requested resource not found
500, 502, 503, 504 | Something wrong with Eliq Integration API
## Error body
Eliq Integration API returns an error response body on failures to provide additional information on the error. Please find the error body and description below.
```json
{
"code":"",
"description":"",
"request_id":"16a3ae43-ca5f-455e-9aef-f93679bedc8d"
}
```
*Field* | *Type* | *Description*
--- | --- | ---
code | String | Error code. Possible error codes per request can be found in each request section. Error codes do not change, and can be used to tie actions to.
description | String | A description of the error for developers
request_id | String | Identifier of the request. Passed when in contact with support
## Request ID
Each API request has an associated request id. You can find this value in the response headers, under X-Request-Id. The request id can be used in communication with Eliq support.'
contact:
name: Support
email: support_b2b@eliq.com
version: 1.5.2
tags:
- name: Meter Energy High Resolution
paths:
/meters/{id}/energy/highres/{resolution}:
post:
tags:
- Meter Energy High Resolution
summary: Creates or updates high resolution (hourly or higher) energy data for a meter
operationId: post-high-resolution-energy-meterid
parameters:
- name: id
in: path
description: Meter external reference
required: true
schema:
type: string
- name: resolution
in: path
description: Resolution of the data provided
required: true
schema:
type: string
requestBody:
description: High resolution energy object to create or update
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EnergyHighResolutionData'
examples:
Energy high resolution data:
value:
- interval_start: '2024-01-01T00:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T01:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T02:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T03:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T04:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T05:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T06:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T07:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T08:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T09:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T10:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T11:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T12:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T13:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T14:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T15:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T16:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T17:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T18:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T19:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T20:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T21:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T22:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T23:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-02T00:00:00Z'
energy_wh: 1000.0
is_estimated: false
responses:
'204':
description: No Content
content:
application/json:
schema:
$ref: '#/components/schemas/NoContentResult'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Request input is missing. This may be caused by incorrect format of input.:
value:
code: INPUT_MISSING
description: Request input is missing. This may be caused by incorrect format of input.
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Parameter 'id' must not be null or empty:
value:
code: METER_ID_MISSING
description: Parameter 'id' must not be null or empty
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Resolution must not be null or empty:
value:
code: RESOLUTION_MISSING
description: Resolution must not be null or empty
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'Invalid resolution. Must be one of: [hour, 30min, 15min, 10min, 6min]':
value:
code: RESOLUTION_INVALID
description: 'Invalid resolution. Must be one of: [hour, 30min, 15min, 10min, 6min]'
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Maximum limit of element per request exceeded. Please refer to documentation for more information:
value:
code: ENERGY_SEQUENCE_LENGTH_LIMIT_EXCEEDED
description: Maximum limit of element per request exceeded. Please refer to documentation for more information
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Energy elements in sequence must be unique:
value:
code: ENERGY_SEQUENCE_CONTAINS_DUPLICATE_ELEMENTS
description: Energy elements in sequence must be unique
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Parameter 'energy_wh' must not be negative:
value:
code: ENERGY_ELEMENT_ENERGY_WH_INVALID
description: Parameter 'energy_wh' must not be negative
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Element in sequence must have either parameter 'energy_wh' or 'energy_m3':
value:
code: ENERGY_ELEMENT_ENERGY_WH_AND_ENERGY_M3_MISSING
description: Element in sequence must have either parameter 'energy_wh' or 'energy_m3'
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Element in sequence must have either parameter 'energy_wh' or 'energy_m3' but not both:
value:
code: ENERGY_ELEMENT_BOTH_ENERGY_WH_AND_ENERGY_M3_SET
description: Element in sequence must have either parameter 'energy_wh' or 'energy_m3' but not both
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Element in sequence has 'energy_m3' but the meter's fuel does not support it. 'energy_wh' is supported:
value:
code: ENERGY_ELEMENT_ENERGY_M3_ON_UNSUPPORTED_FUEL_METER
description: Element in sequence has 'energy_m3' but the meter's fuel does not support it. 'energy_wh' is supported
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
? Parameter 'interval_start' must not be null. This may be caused by incorrect datetime format, please refer to documentation
: value:
code: ENERGY_ELEMENT_INTERVAL_START_MISSING
description: Parameter 'interval_start' must not be null. This may be caused by incorrect datetime format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
? Parameter 'interval_start' must align with given resolution (eg. 'xx:00:00' for hourly, 'xx:00:00' and 'xx:30:00' for 30min). Please refer to documentation for more information
: value:
code: ENERGY_ELEMENT_INTERVAL_START_DATE_INVALID_FOR_RESOLUTION
description: Parameter 'interval_start' must align with given resolution (eg. 'xx:00:00' for hourly, 'xx:00:00' and 'xx:30:00' for 30min). Please refer to documentation for more information
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Gap not matching resolution size between 'interval_start' dates have been found.:
value:
code: GAP_IN_ENERGY_DATE_INTERVAL
description: Gap not matching resolution size between 'interval_start' dates have been found.
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Parameter 'interval_start' must be between meter SupplyStartDate and SupplyEndDate dates.:
value:
code: ENERGY_INTERVAL_START_DATE_IS_OUTSIDE_METER_SUPPLY_DATE_RANGE
description: Parameter 'interval_start' must be between meter SupplyStartDate and SupplyEndDate dates.
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Meter with given id could not be found:
value:
code: METER_NOT_FOUND
description: Meter with given id could not be found
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Internal server error. If problem remains, please contact support:
value:
code: INTERNAL_ERROR
description: Internal server error. If problem remains, please contact support
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
delete:
tags:
- Meter Energy High Resolution
summary: Deletes the high resolution (hourly or higher) energy data for a meter
operationId: delete-high-resolution-energy-meterid-2
parameters:
- name: id
in: path
description: Meter external reference
required: true
schema:
type: string
- name: resolution
in: path
description: Resolution of the data provided
required: true
schema:
type: string
- name: FromDate
in: query
schema:
type: string
- name: From
in: query
schema:
type: string
- name: ToDate
in: query
schema:
type: string
- name: To
in: query
schema:
type: string
responses:
'204':
description: No Content
content:
application/json:
schema:
$ref: '#/components/schemas/NoContentResult'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation:
value:
code: DATE_RANGE_MISSING
description: Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Parameter 'id' must not be null or empty:
value:
code: METER_ID_MISSING
description: Parameter 'id' must not be null or empty
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Resolution must not be null or empty:
value:
code: RESOLUTION_MISSING
description: Resolution must not be null or empty
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
From date is missing. This may be caused by incorrect date format, please refer to documentation:
value:
code: FROM_MISSING
description: From date is missing. This may be caused by incorrect date format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
To date is missing. This may be caused by incorrect date format, please refer to documentation:
value:
code: TO_MISSING
description: To date is missing. This may be caused by incorrect date format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Date range is invalid i.e. 'from' date is after 'to' date:
value:
code: DATE_RANGE_INVALID
description: Date range is invalid i.e. 'from' date is after 'to' date
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Meter with given id could not be found:
value:
code: METER_NOT_FOUND
description: Meter with given id could not be found
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Internal server error. If problem remains, please contact support:
value:
code: INTERNAL_ERROR
description: Internal server error. If problem remains, please contact support
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
get:
tags:
- Meter Energy High Resolution
summary: Gets the stored high resolution (hour or higher) energy data for a meter within…
operationId: get-high-resolution-energy-meterid
parameters:
- name: id
in: path
description: Meter external reference
required: true
schema:
type: string
- name: resolution
in: path
description: Resolution of the data provided
required: true
schema:
type: string
- name: FromDate
in: query
schema:
type: string
- name: From
in: query
schema:
type: string
- name: ToDate
in: query
schema:
type: string
- name: To
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EnergyHighResolutionData'
examples:
Energy high resolution data:
value:
- interval_start: '2024-01-01T00:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T01:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T02:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T03:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T04:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T05:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T06:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T07:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T08:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T09:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T10:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T11:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T12:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T13:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T14:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T15:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T16:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T17:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T18:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T19:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T20:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T21:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T22:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-01T23:00:00Z'
energy_wh: 1000.0
is_estimated: false
- interval_start: '2024-01-02T00:00:00Z'
energy_wh: 1000.0
is_estimated: false
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation:
value:
code: DATE_RANGE_MISSING
description: Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Parameter 'id' must not be null or empty:
value:
code: METER_ID_MISSING
description: Parameter 'id' must not be null or empty
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Resolution must not be null or empty:
value:
code: RESOLUTION_MISSING
description: Resolution must not be null or empty
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'Invalid resolution. Must be one of: [hour, 30min, 15min, 10min, 6min]':
value:
code: RESOLUTION_INVALID
description: 'Invalid resolution. Must be one of: [hour, 30min, 15min, 10min, 6min]'
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
From date is missing. This may be caused by incorrect date format, please refer to documentation:
value:
code: FROM_MISSING
description: From date is missing. This may be caused by incorrect date format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
To date is missing. This may be caused by incorrect date format, please refer to documentation:
value:
code: TO_MISSING
description: To date is missing. This may be caused by incorrect date format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Date range is invalid i.e. 'from' date is after 'to' date:
value:
code: DATE_RANGE_INVALID
description: Date range is invalid i.e. 'from' date is after 'to' date
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Maximum range between 'from' and 'to' exceeded. Please refer to documentation:
value:
code: DATE_RANGE_LIMIT_EXCEEDED
description: Maximum range between 'from' and 'to' exceeded. Please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Meter with given id could not be found:
value:
code: METER_NOT_FOUND
description: Meter with given id could not be found
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Internal server error. If problem remains, please contact support:
value:
code: INTERNAL_ERROR
description: Internal server error. If problem remains, please contact support
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
/meters/{id}/energy/{resolution}:
delete:
tags:
- Meter Energy High Resolution
summary: Deletes the high resolution (hourly or higher) energy data for a meter
operationId: delete-high-resolution-energy-meterid
parameters:
- name: id
in: path
description: Meter external reference
required: true
schema:
type: string
- name: resolution
in: path
description: Resolution of the data provided
required: true
schema:
type: string
- name: FromDate
in: query
schema:
type: string
- name: From
in: query
schema:
type: string
- name: ToDate
in: query
schema:
type: string
- name: To
in: query
schema:
type: string
responses:
'204':
description: No Content
content:
application/json:
schema:
$ref: '#/components/schemas/NoContentResult'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation:
value:
code: DATE_RANGE_MISSING
description: Missing parameters 'from' and 'to'. This may be caused by incorrect date format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Parameter 'id' must not be null or empty:
value:
code: METER_ID_MISSING
description: Parameter 'id' must not be null or empty
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Resolution must not be null or empty:
value:
code: RESOLUTION_MISSING
description: Resolution must not be null or empty
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
From date is missing. This may be caused by incorrect date format, please refer to documentation:
value:
code: FROM_MISSING
description: From date is missing. This may be caused by incorrect date format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
To date is missing. This may be caused by incorrect date format, please refer to documentation:
value:
code: TO_MISSING
description: To date is missing. This may be caused by incorrect date format, please refer to documentation
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
Date range is invalid i.e. 'from' date is after 'to' date:
value:
code: DATE_RANGE_INVALID
description: Date range is invalid i.e. 'from' date is after 'to' date
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Meter with given id could not be found:
value:
code: METER_NOT_FOUND
description: Meter with given id could not be found
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
examples:
Internal server error. If problem remains, please contact support:
value:
code: INTERNAL_ERROR
description: Internal server error. If problem remains, please contact support
request_id: 65e2ea86-470f-4363-9295-35d6b473981a
components:
schemas:
ErrorDetails:
required:
- code
- description
type: object
properties:
code:
minLength: 1
type: string
description:
minLength: 1
type: string
request_id:
type:
- string
- 'null'
EnergyHighResolutionData:
type: object
properties:
interval_start:
type:
- string
- 'null'
energy_wh:
type:
- number
- 'null'
format: float
energy_m3:
type:
- number
- 'null'
format: float
is_estimated:
type: boolean
NoContentResult:
type: object
properties:
statusCode:
type: integer
format: int32
x-tagGroups:
- name: Users
tags:
- User
- name: Locations
tags:
- Location
- Location profile
- Location home profile
- Location price formulas
- name: Meters
tags:
- Meter
- Meter Energy Day
- Meter Energy High Resolution
- Meter Energy Reads
- Meter Energy Period
- Meter Max Demand
- Meter Price Formulas
- name: Jobs
tags:
- Jobs
- name: Portfolio
tags:
- Portfolio Accounts
- Portfolio Groups
- Portfolio Locations
- Portfolio Users
- name: Client details
tags:
- Client details