Form3

Form3 Metrics API

The Metrics API API from Form3 — 3 operation(s) for metrics api.

GitHub OpenAPI

Operations 5

GET /metrics/prometheus/api/v1/query Query Endpoint for metrics #
POST /metrics/prometheus/api/v1/query Query Endpoint for metrics #
GET /metrics/prometheus/api/v1/query_range Query Range Endpoint for metrics #
POST /metrics/prometheus/api/v1/query_range Query Range Endpoint for metrics #
GET /metrics/prometheus/federate Federate Endpoint for metrics #

Documentation

📖
Documentation
https://www.api-docs.form3.tech/
📖
APIReference
https://api-docs.form3.tech/api.html
📖
GettingStarted
https://www.api-docs.form3.tech/api/tutorials/getting-started/introduction
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/getting-started/send-a-payment
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/getting-started/receive-a-payment
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/bacs/receive-a-direct-debit
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/confirmation-of-payee/cop-tutorial
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/bacs/send-transactions-in-a-file
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/event-notifications/subscriptions-for-event-notifications
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/event-notifications/verify-event-notifications
📖
Documentation
https://www.api-docs.form3.tech/api/tutorials/security/create-a-read-only-user

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/form3/refs/heads/main/openapi/form3-metrics-api-api-openapi.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/form3-metrics-api-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

form3-metrics-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Form3 Public Metrics API
  version: '1'
servers:
- url: https://api.form3.tech/v1
security:
- OAuth2: []
tags:
- name: Metrics API
paths:
  /metrics/prometheus/api/v1/query:
    get:
      parameters:
      - description: Query to Execute
        in: query
        name: query
        required: true
        schema:
          type: string
      - description: RFC3339 or unix_timestamp
        in: query
        name: time
        required: false
        schema:
          type: string
      - description: See https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations
        in: query
        name: timeout
        required: false
        schema:
          type: string
      responses:
        200:
          description: See Prometheus api https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
        400:
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
        403:
          description: Forbidden
        500:
          description: Internal Server Error
      summary: Query Endpoint for metrics
      tags:
      - Metrics API
      x-access:
      - Public
      operationId: getMetricsPrometheusApiV1Query
      x-operation-id-source: derived
    post:
      responses:
        200:
          description: See Prometheus api https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
        400:
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
        403:
          description: Forbidden
        500:
          description: Internal Server Error
      summary: Query Endpoint for metrics
      tags:
      - Metrics API
      x-access:
      - Public
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: Query to Execute
                time:
                  type: string
                  description: RFC3339 or unix_timestamp
                timeout:
                  type: string
                  description: See https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations
              required:
              - query
      operationId: postMetricsPrometheusApiV1Query
      x-operation-id-source: derived
  /metrics/prometheus/api/v1/query_range:
    get:
      parameters:
      - description: Query to Execute
        in: query
        name: query
        required: true
        schema:
          type: string
      - description: RFC3339 or unix_timestamp
        in: query
        name: time
        required: false
        schema:
          type: string
      - description: See https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations
        in: query
        name: timeout
        required: false
        schema:
          type: string
      - description: RFC3339 or unix_timestamp
        in: query
        name: start
        required: false
        schema:
          type: string
      - description: RFC3339 or unix_timestamp
        in: query
        name: end
        required: false
        schema:
          type: string
      - description: duration or float
        in: query
        name: step
        required: false
        schema:
          type: string
      responses:
        200:
          description: See Prometheus api https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
        400:
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
        403:
          description: Forbidden
        500:
          description: Internal Server Error
      summary: Query Range Endpoint for metrics
      tags:
      - Metrics API
      x-access:
      - Public
      operationId: getMetricsPrometheusApiV1QueryRange
      x-operation-id-source: derived
    post:
      responses:
        200:
          description: See Prometheus api https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
        400:
          description: Bad Request
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
        403:
          description: Forbidden
        500:
          description: Internal Server Error
      summary: Query Range Endpoint for metrics
      tags:
      - Metrics API
      x-access:
      - Public
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: Query to Execute
                time:
                  type: string
                  description: RFC3339 or unix_timestamp
                timeout:
                  type: string
                  description: See https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations
                start:
                  type: string
                  description: RFC3339 or unix_timestamp
                end:
                  type: string
                  description: RFC3339 or unix_timestamp
                step:
                  type: string
                  description: duration or float
              required:
              - query
      operationId: postMetricsPrometheusApiV1QueryRange
      x-operation-id-source: derived
  /metrics/prometheus/federate:
    get:
      parameters:
      - description: See https://prometheus.io/docs/prometheus/latest/querying/basics/#instant-vector-selectors
        in: query
        name: match[]
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        200:
          description: See Prometheus api https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries
          content:
            text/plain:
              schema:
                type: string
        400:
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/MetricsQueryResponse'
        403:
          description: Forbidden
        500:
          description: Internal Server Error
      summary: Federate Endpoint for metrics
      tags:
      - Metrics API
      x-access:
      - Public
      operationId: getMetricsPrometheusFederate
      x-operation-id-source: derived
components:
  schemas:
    prometheusMetric:
      additionalProperties:
        type: string
      type: object
      x-access:
      - Public
    prometheusResultItem:
      properties:
        metric:
          $ref: '#/components/schemas/prometheusMetric'
        value:
          items: {}
          type: array
      type: object
      x-access:
      - Public
    prometheusMetricData:
      properties:
        result:
          $ref: '#/components/schemas/prometheusResult'
        resultType:
          type: string
      type: object
      x-access:
      - Public
    prometheusResult:
      items:
        $ref: '#/components/schemas/prometheusResultItem'
      type: array
      x-access:
      - Public
    MetricsQueryResponse:
      properties:
        data:
          $ref: '#/components/schemas/prometheusMetricData'
        error:
          type: string
        errorType:
          type: string
        status:
          type: string
        warnings:
          items:
            type: string
          type: array
      type: object
      x-access:
      - Public
  securitySchemes:
    Basic:
      type: http
      scheme: basic
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://api.form3.tech/v1/oauth2/token
      description: OAuth 2.0 with Client Credentials Grant type