Skip to main content
← All datasets

Custom Peer Groups

Free

List or save the caller's custom peer groups.

About this dataset

Custom Peer Groups is a Free dataset in the Screeners group of the BankRegReports Data API. The response carries 10 documented fields.

GET lists the caller's groups. POST creates a new group, or updates an existing one when `id` is supplied in the body.

Endpoint

GET POST /api/v1/peer-groups/custom/

Response fields

Field Type Description
id integer
name string
kind string
rssd_ids array of integer Bank groups.
cu_numbers array of integer Credit-union groups (NCUA charter numbers).
bank_count integer Filing Institutions (count)
member_count integer
definition
created_at string (date-time)
updated_at string (date-time)

Example request

curl "https://api.bankregreports.com/api/v1/peer-groups/custom/" \
  -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",
      "name": "string",
      "kind": "string",
      "rssd_ids": "array of integer",
      "cu_numbers": "array of integer",
      "bank_count": "integer",
      "member_count": "integer",
      "definition": "value"
      ... 2 more fields
    }
  ],
  "meta": { ... }
}

When to use it

Custom Peer Groups 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_groups 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

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.custom_peer_groups()
Powered by BankRegReports API