Eliq

Eliq Location Segmentation API

The LocationSegmentation API from Eliq — 6 operation(s) for locationsegmentation.

GitHub OpenAPI

Operations 6

POST /locations/segmentation/filter Filters Location Segmentation data #
POST /locations/segmentation/export/create Creates an export job to export all segments to a CSV file #
GET /locations/segmentation/export/{jobId} Gets the export job #
GET /locations/segmentation/export/{jobId}/download Downloads the file containing exported locations #
GET /locations/segmentation/filter/tariffValues Get tariff filter options. #
POST /locations/segmentation/map Create locations segmentation map #

Documentation

📖
Documentation
https://developer.eliq.com/api-reference
📖
APIReference
https://developer.eliq.com/api-reference/auth-api
📖
Authentication
https://artifacts.apis.io/eliq/authentication/eliq-authentication.yml
📖
Documentation
https://developer.eliq.com/doc/eliq-apis
📖
APIReference
https://developer.eliq.com/api-reference/data-mgmt-api
📖
Documentation
https://developer.eliq.com/doc/energy-insights-for-businesses
📖
Documentation
https://developer.eliq.com/doc/device-specific-energy-insights
📖
APIReference
https://developer.eliq.com/api-reference/insights-api
📖
APIReference
https://developer.eliq.com/api-reference/intelligence-api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/eliq/openapi/eliq-locationsegmentation-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/eliq/json-schema/eliq-filter-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/eliq/json-schema/eliq-paged-filter-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/eliq/json-schema/eliq-export-job-schema.json
📊
JSONSchema
https://artifacts.apis.io/eliq/json-schema/eliq-filter-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/eliq/json-schema/eliq-map-segmentation-response-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/eliq/json-schema/eliq-tariff-filter-options-schema.json

Other Resources

🔗
DeveloperPortal
https://developer.eliq.com
🔗
OAuthScopes
https://artifacts.apis.io/eliq/scopes/eliq-scopes.yml
🔗
ErrorCatalog
https://artifacts.apis.io/eliq/errors/eliq-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/eliq/data-model/eliq-data-model.yml
🔗
Webhooks
https://artifacts.apis.io/eliq/asyncapi/eliq-webhooks.yml
🔗
Components
https://artifacts.apis.io/eliq/components/eliq-components.yml

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-locationsegmentation-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

eliq-locationsegmentation-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Eliq Intelligence Location Segmentation API
  description: '# API Reference


    The Eliq Intelligence 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 resource oriented around Eliq''s Intelligence capabilities.


    # Errors


    ## Error body


    The 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":""

    }

    ```


    *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'
  contact:
    name: Support
    email: support_b2b@eliq.com
  version: 1.0.0
security:
- Bearer: []
tags:
- name: LocationSegmentation
paths:
  /locations/segmentation/filter:
    post:
      tags:
      - LocationSegmentation
      summary: Filters Location Segmentation data
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PagedFilterRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/PagedFilterRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/PagedFilterRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PagedFilterRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      operationId: postLocationsSegmentationFilter
      x-operation-id-source: derived
  /locations/segmentation/export/create:
    post:
      tags:
      - LocationSegmentation
      summary: Creates an export job to export all segments to a CSV file
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
      responses:
        '201':
          description: Returns the newly created export job
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      operationId: postLocationsSegmentationExportCreate
      x-operation-id-source: derived
  /locations/segmentation/export/{jobId}:
    get:
      tags:
      - LocationSegmentation
      summary: Gets the export job
      parameters:
      - name: jobId
        in: path
        description: The ID of the export job.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportJob'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      operationId: getLocationsSegmentationExportByJobId
      x-operation-id-source: derived
  /locations/segmentation/export/{jobId}/download:
    get:
      tags:
      - LocationSegmentation
      summary: Downloads the file containing exported locations
      parameters:
      - name: jobId
        in: path
        description: The ID of the export job.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      operationId: getLocationsSegmentationExportByJobIdDownload
      x-operation-id-source: derived
  /locations/segmentation/filter/tariffValues:
    get:
      tags:
      - LocationSegmentation
      summary: Get tariff filter options.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TariffFilterOptions'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      operationId: getLocationsSegmentationFilterTariffValues
      x-operation-id-source: derived
  /locations/segmentation/map:
    post:
      tags:
      - LocationSegmentation
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FilterRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapSegmentationResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      summary: Create locations segmentation map
      x-summary-source: derived
      operationId: postLocationsSegmentationMap
      x-operation-id-source: derived
components:
  schemas:
    JsonNodeOptions:
      type: object
      properties:
        propertyNameCaseInsensitive:
          type: boolean
      additionalProperties: false
    TariffSummary:
      type: object
      properties:
        tariffId:
          type:
          - string
          - 'null'
        tariffName:
          type:
          - string
          - 'null'
        annualSavings:
          type: number
          format: double
        annualCosts:
          type: number
          format: double
      additionalProperties: false
    PvDetails:
      type: object
      properties:
        estimatedProductionKwh:
          type:
          - number
          - 'null'
          format: double
        selfConsumptionPercentage:
          type:
          - number
          - 'null'
          format: double
        detectionSource:
          $ref: '#/components/schemas/PvDetectionSource'
        confidence:
          type:
          - number
          - 'null'
          format: double
      additionalProperties: false
    ElectricVehicle:
      type: object
      properties:
        chargedKwh:
          type: number
          format: double
        chargedPowerKw:
          type:
          - array
          - 'null'
          items:
            type: number
            format: double
        confidence:
          type:
          - number
          - 'null'
          format: double
      additionalProperties: false
    Summary:
      type: object
      properties:
        totalLocations:
          type: integer
          format: int64
        filteredLocations:
          type: integer
          format: int64
        optimalTariffs:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/TariffCount'
        electricVehicles:
          type: integer
          format: int64
        pv:
          type: integer
          format: int64
        gasHeating:
          type: integer
          format: int64
        elecHeating:
          type: integer
          format: int64
        battery:
          type: integer
          format: int64
      additionalProperties: false
    Operator:
      enum:
      - eq
      - neq
      - gt
      - lt
      - gte
      - lte
      type: string
    TariffFilterOptions:
      type: object
      properties:
        tariffId:
          type:
          - string
          - 'null'
        tariffName:
          type:
          - string
          - 'null'
      additionalProperties: false
    HeatingDetails:
      type: object
      properties:
        estimatedGasHeatingKwh:
          type:
          - number
          - 'null'
          format: double
        estimatedElecHeatingKwh:
          type:
          - number
          - 'null'
          format: double
        primaryHeatingFuel:
          type:
          - string
          - 'null'
        otherHeatingFuels:
          $ref: '#/components/schemas/HeatingFuelFlags'
      additionalProperties: false
    MapSegmentationResponseDto:
      type: object
      properties:
        locations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MapLocationDto'
      additionalProperties: false
    MapLocationDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
        ev:
          type: boolean
        pv:
          type: boolean
        elecHeat:
          type: boolean
        gasHeat:
          type: boolean
        battery:
          type: boolean
        lat:
          type: number
          format: double
        lon:
          type: number
          format: double
      additionalProperties: false
    ExportJob:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/ExportJobStatus'
      additionalProperties: false
    ExportJobStatus:
      enum:
      - Created
      - Pending
      - Complete
      - Failed
      type: string
    PagingRequest:
      type: object
      properties:
        page:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
      additionalProperties: false
    FilterResponse:
      type: object
      properties:
        summary:
          $ref: '#/components/schemas/Summary'
        locations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FilterResponseItem'
        paging:
          $ref: '#/components/schemas/Paging'
      additionalProperties: false
    Paging:
      type: object
      properties:
        currentPage:
          type: integer
          format: int32
        pages:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
      additionalProperties: false
    ErrorDetails:
      required:
      - code
      - description
      type: object
      properties:
        code:
          minLength: 1
          type: string
        description:
          minLength: 1
          type: string
      additionalProperties: false
    FilterResponseItem:
      type: object
      properties:
        id:
          type: integer
          format: int32
        assets:
          $ref: '#/components/schemas/Assets'
        consumptionKwh:
          type:
          - number
          - 'null'
          format: double
        totalGridImportKwh:
          type:
          - number
          - 'null'
          format: double
        totalGridExportKwh:
          type:
          - number
          - 'null'
          format: double
        locationExtRef:
          type:
          - string
          - 'null'
        userId:
          type:
          - integer
          - 'null'
          format: int32
        userExtRef:
          type:
          - string
          - 'null'
        fromDate:
          type: string
          format: date
        toDate:
          type: string
          format: date
      additionalProperties: false
    AssetKind:
      enum:
      - ElectricVehicle
      - Tariff
      - pv
      - GasHeating
      - ElecHeating
      - battery
      type: string
    Assets:
      type: object
      properties:
        electricVehicle:
          $ref: '#/components/schemas/ElectricVehicle'
        tariff:
          $ref: '#/components/schemas/Tariffs'
        pvDetails:
          $ref: '#/components/schemas/PvDetails'
        heatingDetails:
          $ref: '#/components/schemas/HeatingDetails'
        battery:
          $ref: '#/components/schemas/Battery'
      additionalProperties: false
    Tariffs:
      type: object
      properties:
        optimalTariff:
          $ref: '#/components/schemas/TariffSummary'
      additionalProperties: false
    FilterRequestAsset:
      required:
      - asset
      type: object
      properties:
        asset:
          $ref: '#/components/schemas/AssetKind'
        exists:
          type: boolean
        properties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FilterRequestAssetProperty'
      additionalProperties: false
    JsonNode:
      type: object
      properties:
        options:
          $ref: '#/components/schemas/JsonNodeOptions'
        parent:
          $ref: '#/components/schemas/JsonNode'
        root:
          $ref: '#/components/schemas/JsonNode'
      additionalProperties: false
    Battery:
      type: object
      properties:
        score:
          type: number
          format: double
      additionalProperties: false
    HeatingFuelFlags:
      type: object
      properties:
        elec:
          type:
          - boolean
          - 'null'
        gas:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    PvDetectionSource:
      enum:
      - disaggregation
      - import_regression
      type: string
    TariffCount:
      type: object
      properties:
        tariffId:
          type:
          - string
          - 'null'
        count:
          type: integer
          format: int32
      additionalProperties: false
    FilterRequestAssetProperty:
      type: object
      properties:
        field:
          type:
          - string
          - 'null'
        operator:
          $ref: '#/components/schemas/Operator'
        value:
          $ref: '#/components/schemas/JsonNode'
      additionalProperties: false
    PagedFilterRequest:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingRequest'
        filters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FilterRequestAsset'
      additionalProperties: false
    FilterRequest:
      type: object
      properties:
        filters:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FilterRequestAsset'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: Enter JWT Bearer token **_only_**
      scheme: bearer
      bearerFormat: JWT