Watchlist Alerts

About this dataset

Watchlist Alerts is a Free dataset in the Reference & Catalog group of the BankRegReports Data API. The response carries 17 documented fields.

Threshold alerts on metric values for banks the user is watching.

Endpoint

GET POST /api/v1/watchlist/alerts/

Response fields

Field	Type	Description
id	integer
rssd_id	integer	RSSD ID (count)
bank_name	string
metric	string
direction	string	* `above` - above * `below` - below
threshold	number (double)
last_value	number (double), nullable
last_triggered	string (date-time), nullable
is_active	boolean
current_value	number (double), nullable
current_as_of	string (date), nullable
met_now	boolean, nullable
metric_label	string
unit	string
filing_stale	boolean
threshold_out_of_range	boolean
threshold_always_met	boolean

Example request

curl "https://api.bankregreports.com/api/v1/watchlist/alerts/" \
  -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": "integer",
      "rssd_id": "integer",
      "bank_name": "string",
      "metric": "string",
      "direction": "string",
      "threshold": "number (double)",
      "last_value": "number (double)",
      "last_triggered": "string (date-time)"
      ... 9 more fields
    }
  ],
  "meta": { ... }
}

When to use it

Watchlist Alerts 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 watchlist_alerts naming it the same way in the REST path, the Python SDK and the OpenAPI document.

Access and authentication

This dataset is in the Free tier. Send your API token in the Authorization header as a Bearer token, using a GET or POST 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 Alert Detail: Toggle or delete one watchlist alert (PATCH/DELETE).
• Saved Graphs: The authenticated user's saved graphs, list or create (GET/POST).

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.dataset("alerts")