About this dataset
Watchlist Alert Detail is a Free dataset in the Reference & Catalog group of the BankRegReports Data API. The response carries 17 documented fields.
DELETE removes the alert. PATCH toggles `is_active` (or sets it explicitly when an `is_active` boolean is supplied in the body).
Endpoint
DELETE PATCH /api/v1/watchlist/alerts/{alert_id}/ Parameters
| Name | Required | Description |
|---|---|---|
| alert_id | required | Alert id. e.g. 1 |
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/1/" \ -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 Alert Detail 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_alert_detail 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 DELETE or PATCH 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).
- 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
The Python SDK does not have a method for this dataset yet. Call the REST endpoint above with any HTTP client.