Graph Detail

Free

Retrieve, update, or delete one saved graph (GET/PUT/DELETE).

About this dataset

Graph Detail is a Free dataset in the Reference & Catalog group of the BankRegReports Data API. The response carries 15 documented fields.

GET succeeds for the owner or any user if the graph is public. PUT/DELETE require ownership; non-owners hitting a public graph get 403, non-owners hitting a private graph get 404 (no existence leak).

Endpoint

GET PUT DELETE /api/v1/graphs/{graph_id}/

Parameters

Name	Required	Description
graph_id	required	Graph id. e.g. 1

Response fields

Field	Type	Description
id	integer
name	string
kind	string
description	string
config
config_version	integer
template_key	string
is_pinned	boolean
visibility	string
owner_id	integer, nullable
owner_name	string
is_owner	boolean
forked_from_id	integer, nullable
forks_count	integer
updated_at	string (date-time)

Example request

curl "https://api.bankregreports.com/api/v1/graphs/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",
      "name": "string",
      "kind": "string",
      "description": "string",
      "config": "value",
      "config_version": "integer",
      "template_key": "string",
      "is_pinned": "boolean"
      ... 7 more fields
    }
  ],
  "meta": { ... }
}

When to use it

Graph 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 graph_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 PUT 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

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

Install with pip install bankregreports and set BANKREG_API_TOKEN to your key.

import bankregreports

brr = bankregreports.BankReg()  # reads BANKREG_API_TOKEN
graph_id = 123  # one of your own saved graphs, from brr.graphs()
result = brr.dataset("graph_detail", graph_id=graph_id)