Hypervolt Reporting API

The reporting API from Hypervolt — 1 operation(s) for reporting.

GitHub OpenAPI

Operations 2

GET /placements/{id}/report Get a Consumption Report #
POST /placements/{id}/report Send a Consumption Report #

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-reporting-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-reporting-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Hypervolt Reporting API
  version: '0.1'
servers:
- url: https://api.hypervolt.co.uk/
  description: Prod
tags:
- name: Reporting
paths:
  /placements/{id}/report:
    get:
      tags:
      - Reporting
      summary: Get a Consumption Report
      operationId: placement-report
      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: Report start time
        required: false
        schema:
          type: string
          format: date
      - name: end
        in: query
        description: Report end time
        required: false
        schema:
          type: string
          format: date
      - name: name
        in: query
        description: Name displayed on the report header
        required: false
        schema:
          type: string
      - name: email
        in: query
        description: If not provided default to the Placement owner
        required: false
        schema:
          description: Email (see RFC 5322)
          example: jon.snow@stark.got
          type: string
      - name: synthetic
        in: query
        description: Include synthetic sessions, and tag energy reported across a reporting gap
        required: false
        schema:
          type: boolean
      - name: rows
        in: query
        description: One row per charging `session` (default), or per `day` with charging, so energy is attributed to the day it was delivered on
        required: false
        schema:
          type: string
          enum:
          - session
          - day
      responses:
        '200':
          description: A Consumption Report PDF
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '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: []
    post:
      tags:
      - Reporting
      summary: Send a Consumption Report
      description: Send a Consumption Report to the provided email or to the Placement owner.
      operationId: placement-send-report
      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: Report start time
        required: false
        schema:
          type: string
          format: date
      - name: end
        in: query
        description: Report end time
        required: false
        schema:
          type: string
          format: date
      - name: name
        in: query
        description: Name displayed on the report header
        required: false
        schema:
          type: string
      - name: email
        in: query
        description: If not provided default to the Placement owner
        required: false
        schema:
          description: Email (see RFC 5322)
          example: jon.snow@stark.got
          type: string
      - name: synthetic
        in: query
        description: Include synthetic sessions, and tag energy reported across a reporting gap
        required: false
        schema:
          type: boolean
      - name: rows
        in: query
        description: One row per charging `session` (default), or per `day` with charging, so energy is attributed to the day it was delivered on
        required: false
        schema:
          type: string
          enum:
          - session
          - day
      responses:
        '200':
          description: ''
        '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:
  securitySchemes:
    JWT:
      type: http
      scheme: bearer