Dataset Detail

Public

One dataset entry from the product catalog.

About this dataset

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

GET /api/v1/datasets/{key}/

Endpoint

GET /api/v1/datasets/{key}/

Parameters

Name	Required	Description
key	required	Dataset key. e.g. bank

Response fields

Field	Type	Description
key	string
title	string
category	string
classification	string
badge	string
summary	string
path	string
methods	array of string
params	array of object
source	string
sdk_method	string

Example request

curl "https://api.bankregreports.com/api/v1/datasets/bank/" \
  -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": [
    {
      "key": "string",
      "title": "string",
      "category": "string",
      "classification": "string",
      "badge": "string",
      "summary": "string",
      "path": "string",
      "methods": "array of string"
      ... 3 more fields
    }
  ],
  "meta": { ... }
}

When to use it

Dataset 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 dataset_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 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

The Python SDK does not have a method for this dataset yet. Call the REST endpoint above with any HTTP client.