Hypervolt Address API

The address API from Hypervolt — 2 operation(s) for address.

GitHub OpenAPI

Operations 2

GET /address/GB/autocomplete Autocomplete a GB address #
GET /address/GB/{autocompletion-id} Gets a GB address #

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-address-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-address-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Hypervolt Address API
  version: '0.1'
servers:
- url: https://api.hypervolt.co.uk/
  description: Prod
tags:
- name: Address
paths:
  /address/GB/autocomplete:
    get:
      tags:
      - Address
      summary: Autocomplete a GB address
      description: Autocompletes a GB address starting from a fragment. It returns suggestions that can be expanded using the provided id
      operationId: address-gb-autocomplete
      parameters:
      - name: address
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoCompleteResponse'
        '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: []
  /address/GB/{autocompletion-id}:
    get:
      tags:
      - Address
      summary: Gets a GB address
      description: Retrieves a full GB address using the id that was provided by the autocompletion service
      operationId: address-gb-get
      parameters:
      - name: autocompletion-id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
        '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:
    Address:
      title: Address
      description: A complete GB address
      type: object
      required:
      - postcode
      - latitude
      - longitude
      - thoroughfare
      - buildingName
      - subBuildingName
      - subBuildingNumber
      - buildingNumber
      - line1
      - line2
      - line3
      - line4
      - locality
      - townOrCity
      - county
      - district
      - country
      - residential
      properties:
        postcode:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        formattedAddress:
          type: array
          items:
            type: string
        thoroughfare:
          type: string
        buildingName:
          type: string
        subBuildingName:
          type: string
        subBuildingNumber:
          type: string
        buildingNumber:
          type: string
        line1:
          type: string
        line2:
          type: string
        line3:
          type: string
        line4:
          type: string
        locality:
          type: string
        townOrCity:
          type: string
        county:
          type: string
        district:
          type: string
        country:
          type: string
        residential:
          type: boolean
    AutoCompleteResponse:
      title: AutoCompleteResponse
      type: object
      properties:
        suggestions:
          type: array
          items:
            $ref: '#/components/schemas/AutoCompleteSuggestions'
    AutoCompleteSuggestions:
      title: AutoCompleteSuggestions
      description: A single autocomplete suggestion whose id can be used to GET the full address
      type: object
      required:
      - address
      - url
      - id
      properties:
        address:
          type: string
        url:
          type: string
        id:
          type: string
  securitySchemes:
    JWT:
      type: http
      scheme: bearer