Eliq

Eliq Price Formulas API

The Price Formulas API from Eliq — 1 operation(s) for price formulas.

Documentation GitHub OpenAPI

Operations 1

GET /v3/locations/{locationId}/price-formula Get price formulas #

Work with this as data

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-price-formulas-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Insights Price Formulas API
  version: 3.4.1
  contact:
    name: Insights Team
    email: support_b2b@eliq.com
  description: '# API Reference


    The Eliq insights API is organized around REST.

    API has predictable resource oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs.

    Insights API contains endpoints for two entities: Users and Locations.


    # Date and Time


    Dates and Datetimes follow ISO 8601 format.

    All dates and times are in `local time zone` - no UTC or other timezone specification is allowed for the queries and will result in error. Local timezone was chosen to make the data ready for presentation.


    # Responses and Errors


    Eliq insights API uses standard HTTP response codes to indicate success or failure of a request:

    - 2xx indicate success

    - 4xx indicate error due to invalid input

    - 5xx indicates an internal error of Eliq Insights API


    ## Status codes


    *Status code* | *Description*

    --- | ---

    200 - OK | Everything worked as expected.

    201 - Created | Resource created.

    204 - No Content | Successful request. Used in successful delete requests

    302 - Found | Resource requested has been temporarily moved to the URL given by the Location header.

    400 - Bad Request | Request input data is invalid.

    401 - Unauthorized | Access token invalid for the given request. E.g. access token expired.

    404 - Not Found | Requested resource not found.

    500, 502, 503, 504 | Something wrong with the Insights API.


    ## Error body


    Eliq Insights API returns an error response body on failures to provide additional information on the error.


    Some fields have been deprecated. Deprecated fields will continue to be used in existing endpoints, but will not show up in any new additions.


    | *Field* | *Type* | *Deprecated* | *Description* |

    | --- | --- | --- | --- |

    | type | String | Yes | Type of error. One of `third_party_error`, `internal_error`, `client_error` and `end_user_error`. |

    | category | String | Yes | Category of the error. E.g. `invalid_parameter`. Used to guide developers. |

    | code | String | | Error code specific to each issue. |

    | description | String | | A description of the error for more context and easier debugging.|

    | message | String | Yes | A message related to the error which can be shown to end users. |

    | transaction_id | String | | Transaction identifier with which request is associated. Pass this when contacting support |


    Example:


    ```json

    {

    "type":"client_error",

    "category":"invalid_parameter",

    "code":"MISSING_TO",

    "description":"Invalid parameter ''to''. Cannot be null",

    "message":"Something went wrong, please try again later. If problem remains, please contact support (error: 1ad3a534117d4).",

    "transaction_id":"1ad3a534117d4",

    }

    ```'
servers:
- url: http://localhost:3000
security:
- BearerAuth: []
tags:
- name: Price Formulas
paths:
  /v3/locations/{locationId}/price-formula:
    get:
      tags:
      - Price Formulas
      summary: Get price formulas
      description: Get a list of price formulas for a location and its meters
      operationId: get-v3-locations-locationId-price-formula
      parameters:
      - name: locationId
        in: path
        description: Location id
        required: true
        schema:
          type: integer
          format: int32
      - name: fuel
        in: query
        description: Fuel type
        schema:
          $ref: '#/components/schemas/Fuel'
      - name: direction
        in: query
        description: Direction type
        schema:
          $ref: '#/components/schemas/PriceFormulaDirection'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MeterPriceFormula'
              examples:
                Location Fixed unit rate:
                  value:
                  - fuel: elec
                    direction: import
                    from: '2023-01-01T00:00:00'
                    to: '2023-12-31T00:00:00'
                    currency_code: GBP
                    elements_array:
                    - name: service_charge_day
                      type: charge
                      charge:
                        resolution: day
                        charge: 0.2
                    - name: unit_rate_fixed
                      type: unit_rate
                      unit_rate:
                        type: fixed
                        fixed:
                          unit_rate: 0.15
                    source: client
                Location Nordpool unit rate:
                  value:
                  - fuel: elec
                    direction: import
                    from: '2023-01-01T00:00:00'
                    to: '2023-12-31T00:00:00'
                    currency_code: GBP
                    elements_array:
                    - name: service_charge_day
                      type: charge
                      charge:
                        resolution: day
                        charge: 0.2
                    - name: unit_rate_nordpool
                      type: unit_rate
                      unit_rate:
                        type: nordpool
                        nordpool:
                          region: nordpool_no2
                          resolution: hour
                          multiplier: 1.25
                    source: client
                Meter Nordpool unit rate:
                  value:
                  - meter_id: 111ccf3a1907438fac72e0f231d137ff
                    fuel: elec
                    direction: import
                    from: '2023-01-01T00:00:00'
                    to: '2023-12-31T00:00:00'
                    currency_code: GBP
                    elements_array:
                    - name: service_charge_day
                      type: charge
                      charge:
                        resolution: day
                        charge: 0.2
                    - name: unit_rate_nordpool
                      type: unit_rate
                      unit_rate:
                        type: nordpool
                        nordpool:
                          region: nordpool_no2
                          resolution: hour
                          multiplier: 1.25
                    source: client
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Location not found:
                  value:
                    code: ENTITY_NOT_FOUND
                    transaction_id: 0HN18NIB8K5RV:00000001
                    description: Could not find the location.
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Internal Error:
                  value:
                    code: INTERNAL_SERVER_ERROR
                    transaction_id: 0HN18NIB8K5RV:00000001
                    description: Internal server error.
components:
  schemas:
    SpotPriceProvider:
      enum:
      - nordpool
      - epex
      type: string
    Source:
      enum:
      - client
      - user
      type: string
      description: Price formula source
    Fuel:
      enum:
      - elec
      - gas
      - district_heating
      type: string
      description: Fuel type
    Charge:
      required:
      - resolution
      type: object
      properties:
        resolution:
          $ref: '#/components/schemas/ChargeResolution'
        charge:
          type: number
          description: Charge amount
          format: double
          nullable: true
      description: Object containing the charge. Available when type is set to charge.
    SpotPriceResolution:
      enum:
      - hour
      - 15min
      type: string
    Interval:
      type: object
      properties:
        from_minute:
          type: integer
          format: int64
          nullable: true
        to_minute:
          type: integer
          format: int64
          nullable: true
    Fixed:
      required:
      - unit_rate
      type: object
      properties:
        unit_rate:
          type: number
          description: Fixed unit rate
          format: double
      description: Object containing spot price information. Available if unit rate type is set to 'fixed'
    BlockResolution:
      enum:
      - day
      - year
      type: string
    Nordpool:
      required:
      - region
      - resolution
      type: object
      properties:
        region:
          minLength: 1
          type: string
          description: Region
        resolution:
          $ref: '#/components/schemas/NordpoolResolution'
        multiplier:
          type: number
          description: Multiplier. All Nordpool is by default without VAT. Specify VAT to be used, value 1.25 would result in 25% tax.
          format: double
          nullable: true
      description: Object containing Nordpool information. Available if unit rate type is set to nordpool
    Error:
      type: object
      properties:
        type:
          type: string
          description: Type of error.
          nullable: true
          example: internal_error
        category:
          type: string
          description: Error category.
          nullable: true
          example: internal_error
        code:
          type: string
          description: Code describing the issue.
          nullable: true
          example: INTERNAL_ERROR
        transaction_id:
          type: string
          description: Identifier for the session. Please provide this when contacting support.
          nullable: true
          example: 0HN18NN5QB401:00000001
        message:
          type: string
          description: A message related to the error.
          nullable: true
          example: Something went wrong. Please try again later. If problem remains, please contact support.
        description:
          type: string
          description: A description of the error for developers.
          nullable: true
          example: Internal server error, please try again later. If problem remains, please contact support.
      description: Model returned for error responses.
    PriceElementType:
      enum:
      - charge
      - unit_rate
      type: string
      description: Formula element type.
    MeterPriceFormula:
      type: object
      properties:
        meter_id:
          type: string
          description: Meter id. Applicable only for price formulas set on a meter. Location level formulas which can be applied to multiple meters will have this field empty.
          nullable: true
        fuel:
          $ref: '#/components/schemas/Fuel'
        direction:
          $ref: '#/components/schemas/PriceFormulaDirection'
        from:
          type: string
          description: Price formula start date.
          format: date-time
          nullable: true
        to:
          type: string
          description: Price formula end date.
          format: date-time
          nullable: true
        currency_code:
          type: string
          description: Price formula currency code.
          nullable: true
        elements_array:
          type: array
          items:
            $ref: '#/components/schemas/Element'
          description: List of elements
          nullable: true
        source:
          $ref: '#/components/schemas/Source'
    Element:
      required:
      - name
      - type
      type: object
      properties:
        name:
          minLength: 1
          type: string
          description: Name of the price formula element
        type:
          $ref: '#/components/schemas/PriceElementType'
        charge:
          $ref: '#/components/schemas/Charge'
        unit_rate:
          $ref: '#/components/schemas/UnitRate'
    UnitRate:
      required:
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/UnitRateType'
        fixed:
          $ref: '#/components/schemas/Fixed'
        tou:
          $ref: '#/components/schemas/Tou'
        nordpool:
          $ref: '#/components/schemas/Nordpool'
        block:
          $ref: '#/components/schemas/Block'
        spot_price:
          $ref: '#/components/schemas/SpotPrice'
        weekdays:
          type: array
          items:
            type: string
          nullable: true
      description: Object containing the unit rate. Available when type is set to unit_rate.
    UnitRateType:
      enum:
      - fixed
      - tou
      - nordpool
      - block
      - spot_price
      type: string
      description: Unit rate type
    SpotPrice:
      type: object
      properties:
        provider:
          $ref: '#/components/schemas/SpotPriceProvider'
        region:
          type: string
          nullable: true
        resolution:
          $ref: '#/components/schemas/SpotPriceResolution'
        multiplier:
          type: number
          format: double
          nullable: true
    Block:
      type: object
      properties:
        resolution:
          $ref: '#/components/schemas/BlockResolution'
        register_id:
          type: string
          nullable: true
        unit_rate:
          type: number
          format: double
        from_kwh:
          type: integer
          format: int64
          nullable: true
        to_kwh:
          type: integer
          format: int64
          nullable: true
        from_m3:
          type: integer
          format: int64
          nullable: true
        to_m3:
          type: integer
          format: int64
          nullable: true
    ChargeResolution:
      enum:
      - day
      - month
      type: string
      description: Charge resolution
    Tou:
      type: object
      properties:
        register_id:
          type: string
          nullable: true
        unit_rate:
          type: number
          format: double
          nullable: true
        intervals:
          type: array
          items:
            $ref: '#/components/schemas/Interval'
          nullable: true
        skip_intervals:
          type: boolean
          nullable: true
    NordpoolResolution:
      enum:
      - hour
      type: string
    PriceFormulaDirection:
      enum:
      - import
      - export
      type: string
      description: Direction type
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: The Eliq insights API uses bearer tokens to authenticate requests. Read more under Authentication tag.
x-tagGroups:
- name: Authentication
  tags:
  - Authentication
- name: Users
  tags:
  - Users
- name: Locations
  tags:
  - Locations
  - Location Profile
  - Energy Data
  - Energy Usage Categories
  - Energy Performance Certificate
  - Similar Homes
  - Budgets
  - Advice
  - Anomalies
  - Market Price
  - Price Formulas
- name: Eliq Connect
  tags:
  - Eliq Connect
- name: Health
  tags:
  - Health
- name: Deprecated
  tags:
  - Breakdown
  - Home Profile

Eliq Price Formulas API

Operations 1

Documentation

Specifications

Schemas & Data

Other Resources