Skip to main content
← All datasets

Custom Peer Group Detail

Free

Detail + member snapshots for one custom peer group, or DELETE it.

About this dataset

Custom Peer Group Detail is a Free dataset in the Screeners group of the BankRegReports Data API.

GET returns the group plus the latest snapshot for each member bank. DELETE removes the group.

Endpoint

GET DELETE /api/v1/peer-groups/custom/{group_id}/

Parameters

Name Required Description
group_id required CustomPeerGroup id. e.g. 1

Example request

curl "https://api.bankregreports.com/api/v1/peer-groups/custom/1/" \
  -H "Authorization: Bearer $BANKREG_API_TOKEN"

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

When to use it

Custom Peer Group Detail sits in the Screeners 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 custom_peer_group_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 GET or DELETE 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

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
group_id = 123  # one of your own peer groups, from brr.custom_peer_groups()
result = brr.dataset("custom_peer_group_detail", group_id=group_id)
Powered by BankRegReports API