Metric Catalog

Public

Every available metric with units and definition.

About this dataset

Metric Catalog is a Public dataset in the Reference & Catalog group of the BankRegReports Data API. The response carries 12 documented fields.

Returns every metric the API exposes: display names, units, categories, capability flags. Use this to build dynamic UI or discover what's available without reading documentation.

Endpoint

GET /api/v1/metrics/

Response fields

Field	Type	Description
id	string
display_name	string
short_name	string, nullable
category	string
unit	string
precision	integer
description	string
alertable	boolean
exportable	boolean
screenable	boolean
timeseriesable	boolean
period_basis	string, nullable

Example request

curl "https://api.bankregreports.com/api/v1/metrics/" \
  -H "Authorization: Bearer $BANKREG_API_TOKEN"

Responses are JSON in a {"data": ..., "meta": {...}} envelope. Get a token on the setup page.

Example response shape

A successful call returns HTTP 200 with a JSON body. Each row in data carries the fields below, shown with their documented types rather than sample values.

{
  "data": [
    {
      "id": "string",
      "display_name": "string",
      "short_name": "string",
      "category": "string",
      "unit": "string",
      "precision": "integer",
      "description": "string",
      "alertable": "boolean"
      ... 4 more fields
    }
  ],
  "meta": { ... }
}

When to use it

Metric Catalog sits in the Reference & Catalog group of the Data API. Reach for it when your work needs this data straight from the API: it comes back as JSON you can load into a notebook, a spreadsheet or a scheduled pipeline, with the dataset key metrics naming it the same way in the REST path, the Python SDK and the OpenAPI document.

Access and authentication

This dataset is in the Public tier. Send your API token in the Authorization header as a Bearer token, using a GET request to the endpoint above. The Free plan is the first plan that includes it. Check the plan comparison for request limits, and the data update schedule for when new filings reach the API.

Related datasets

Watchlist: The authenticated user's watchlist, list or add banks (GET/POST).
Watchlist Remove: Remove a bank from the authenticated user's watchlist.
Watchlist Alerts: Threshold metric alerts for banks the user is watching (GET/POST).
Watchlist Alert Detail: Toggle or delete one watchlist alert (PATCH/DELETE).

Keep going

Browse every dataset, follow the setup walkthrough to make a first call, use the Excel add-in for formulas, or connect an assistant through the MCP server.

Python SDK

Install with pip install bankregreports and set BANKREG_API_TOKEN to your key.

import bankregreports

brr = bankregreports.BankReg()  # reads BANKREG_API_TOKEN
result = brr.metrics()