Hypervolt Analytics API

The analytics API from Hypervolt — 3 operation(s) for analytics.

GitHub OpenAPI

Operations 3

GET /placements/{id}/timeline/by-period/{period}/energy Get Energy Timeline #
GET /placements/{id}/sessions Get Placement Costed Sessions #
GET /placements/{id}/composite-sessions Get Placement Costed Composite Sessions #

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/hypervolt:hypervolt-analytics-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

hypervolt-analytics-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Hypervolt Analytics API
  version: '0.1'
servers:
- url: https://api.hypervolt.co.uk/
  description: Prod
tags:
- name: Analytics
paths:
  /placements/{id}/timeline/by-period/{period}/energy:
    get:
      tags:
      - Analytics
      summary: Get Energy Timeline
      description: Provide an extensive view of the various energy measurements (generation, storage system, EV, grid)
      operationId: placement-timeline-energy
      parameters:
      - name: id
        in: path
        required: true
        schema:
          description: Placement ID
          example: 51538b84-2334-49b4-af4a-ad5e4bb00d75
          type: string
          format: uuid
      - name: period
        in: path
        required: true
        schema:
          description: One of '15M', 'h', 'd', 'w', 'm'
          example: d
          type: string
      - name: start
        in: query
        required: false
        schema:
          oneOf:
          - description: An ISO-8601 local date such as '2011-12-03'
            example: '2024-01-20'
            type: string
            format: date
          - description: An ISO-8601 local date time such as '2011-12-03T23:20:50'
            example: '2024-01-20T23:20:50'
            type: string
        examples:
          Example0:
            value: '2023-05-16'
          Example1:
            value: '2023-05-16T13:04:19'
      - name: n
        in: query
        required: false
        schema:
          description: Maximum number of elements to return
          example: 53
          type: integer
          format: int32
      - name: synthetic
        in: query
        description: Include synthetic sessions, and tag energy reported across a reporting gap
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimelineEnergyPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '403':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '410':
          description: Gone
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '425':
          description: ServiceUnavailable
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '503':
          description: ServiceUnavailable
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '504':
          description: Gateway Timeout
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
      security:
      - JWT: []
  /placements/{id}/sessions:
    get:
      tags:
      - Analytics
      summary: Get Placement Costed Sessions
      operationId: placement-sessions
      parameters:
      - name: id
        in: path
        required: true
        schema:
          description: Placement ID
          example: 51538b84-2334-49b4-af4a-ad5e4bb00d75
          type: string
          format: uuid
      - name: start
        in: query
        description: Start time (in placement timezone)
        required: true
        schema:
          oneOf:
          - type: string
          - type: string
            format: date
        examples:
          Example0:
            value: '2023-05-16'
          Example1:
            value: '2023-05-16T13:04:19Z'
      - name: end
        in: query
        description: End time (in placement timezone)
        required: true
        schema:
          oneOf:
          - type: string
          - type: string
            format: date
        examples:
          Example0:
            value: '2023-05-16'
          Example1:
            value: '2023-05-16T13:04:19Z'
      - name: limit
        in: query
        description: Limit
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                - type: array
                  items:
                    type: object
                    required:
                    - start
                    - end
                    - wh
                    properties:
                      start:
                        type: string
                        format: date-time
                      end:
                        type: string
                        format: date-time
                      wh:
                        description: Energy in wh
                        type: number
                        format: double
                      cost:
                        description: Money in cents
                        type: integer
                        format: int64
                - $ref: '#/components/schemas/PagedJson_T'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '403':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '410':
          description: Gone
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '425':
          description: ServiceUnavailable
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '503':
          description: ServiceUnavailable
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '504':
          description: Gateway Timeout
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
      security:
      - JWT: []
  /placements/{id}/composite-sessions:
    get:
      tags:
      - Analytics
      summary: Get Placement Costed Composite Sessions
      operationId: placement-composite-sessions
      parameters:
      - name: id
        in: path
        required: true
        schema:
          description: Placement ID
          example: 51538b84-2334-49b4-af4a-ad5e4bb00d75
          type: string
          format: uuid
      - name: start
        in: query
        description: Start time (in placement timezone)
        required: true
        schema:
          oneOf:
          - type: string
          - type: string
            format: date
        examples:
          Example0:
            value: '2023-05-16'
          Example1:
            value: '2023-05-16T13:04:19Z'
      - name: end
        in: query
        description: End time (in placement timezone)
        required: true
        schema:
          oneOf:
          - type: string
          - type: string
            format: date
        examples:
          Example0:
            value: '2023-05-16'
          Example1:
            value: '2023-05-16T13:04:19Z'
      - name: limit
        in: query
        description: Limit
        required: false
        schema:
          type: integer
          format: int32
      - name: synthetic
        in: query
        description: Include synthetic sessions, and tag energy reported across a reporting gap
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                - type: array
                  items:
                    $ref: '#/components/schemas/CompositeCostedSessionSer'
                - $ref: '#/components/schemas/PagedJson_T'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '403':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '410':
          description: Gone
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '425':
          description: ServiceUnavailable
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '503':
          description: ServiceUnavailable
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
        '504':
          description: Gateway Timeout
          content:
            application/json:
              schema:
                type: object
                required:
                - errors
                properties:
                  errors:
                    type: array
                    items:
                      type: string
      security:
      - JWT: []
components:
  schemas:
    TimelineEnergyPage:
      title: TimelineEnergyPage
      type: object
      required:
      - tz
      properties:
        tz:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/Point'
    PagedJson_T:
      title: PagedJson_T
      type: object
      required:
      - last_page
      properties:
        items:
          type: array
          items:
            type: object
            required:
            - start
            - end
            - wh
            properties:
              start:
                type: string
                format: date-time
              end:
                type: string
                format: date-time
              wh:
                description: Energy in wh
                type: number
                format: double
              cost:
                description: Money in cents
                type: integer
                format: int64
        last_page:
          type: boolean
    CompositeCostedSessionSer:
      title: CompositeCostedSessionSer
      type: object
      required:
      - start
      - end
      - wh
      properties:
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        wh:
          type: number
          format: double
        cost:
          type: integer
          format: int64
        fromOsgEssLowerBound:
          type: number
          format: double
        fromOsgEssMoneyLowerBound:
          type: integer
          format: int64
        fromOsgEss:
          type: number
          format: double
        fromOsgEssMoney:
          type: integer
          format: int64
        toOsgEss:
          type: number
          format: double
        toOsgEssMoney:
          type: integer
          format: int64
        fromOsg:
          type: number
          format: double
        fromOsgMoney:
          type: integer
          format: int64
        toOsg:
          type: number
          format: double
        toOsgMoney:
          type: integer
          format: int64
        fromEss:
          type: number
          format: double
        fromEssMoney:
          type: integer
          format: int64
        toEss:
          type: number
          format: double
        toEssMoney:
          type: integer
          format: int64
        gridExport:
          type: number
          format: double
        gridExportRevenue:
          type: integer
          format: int64
        gridImport:
          type: number
          format: double
        gridImportCost:
          type: integer
          format: int64
        gapSince:
          type: string
          format: date-time
        synthetic:
          type: boolean
    EvBreakdown:
      title: EvBreakdown
      type: object
      required:
      - energy_wh
      properties:
        energy_wh:
          description: Energy in Wh
          example: 1200
          type: integer
          format: int64
        price_cents:
          description: Money in cents
          example: 450
          type: integer
          format: int64
        from_generation:
          $ref: '#/components/schemas/PricedEnergy'
        from_grid:
          $ref: '#/components/schemas/PricedEnergy'
        from_ess:
          $ref: '#/components/schemas/PricedEnergy'
    Point:
      title: Point
      type: object
      required:
      - at
      - to_ev
      properties:
        at:
          type: string
          format: date-time
        to_ev:
          $ref: '#/components/schemas/EvBreakdown'
        to_grid:
          $ref: '#/components/schemas/PricedEnergy'
        from_grid:
          $ref: '#/components/schemas/PricedEnergy'
        to_ess:
          $ref: '#/components/schemas/PricedEnergy'
        from_ess:
          $ref: '#/components/schemas/PricedEnergy'
        from_generation:
          $ref: '#/components/schemas/PricedEnergy'
        gap_since:
          type: string
          format: date-time
    PricedEnergy:
      title: PricedEnergy
      type: object
      required:
      - energy_wh
      properties:
        energy_wh:
          description: Energy in Wh
          example: 1200
          type: integer
          format: int64
        price_cents:
          description: Money in cents
          example: 450
          type: integer
          format: int64
  securitySchemes:
    JWT:
      type: http
      scheme: bearer