Query a multi-bank financial panel
fdic_query_financialsRead-onlyIdempotent
Pull a multi-institution, multi-quarter Call Report panel — one row per institution per quarter — filtered by CERTs, headquarters state, asset range, and thresholds on any catalog metric. Use it to screen (every bank in a state with a noncurrent-loan rate above 3%) or to build a trend panel for SQL. Returns an inline preview sorted as requested; when the panel exceeds the preview it is staged as a dataframe for fdic_dataframe_query. With no dates it covers the latest published quarter only.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| certs | No | Up to 100 CERTs to include; omit to screen every filer. | |
| limit | No | Rows returned inline (1–500). A panel with more rows is also staged whole as a dataframe when this deployment stages dataframes. | |
| state | No | Headquarters state: two-letter code in any case or full name. Branch locations are in fdic_get_deposits. | |
| metrics | No | Up to 30 metric names (fdic_list_reference topic metrics) to return. Omit for the default health set. | |
| sort_by | No | Metric to order the preview (and the staged table) by; added to metrics when absent. Omit to order by newest quarter, then CERT. | |
| to_date | No | Latest quarter, in the same forms as from_date. Omit for the latest published quarter; beside from_date, a later quarter is cut back to it. | |
| from_date | No | Earliest quarter: a quarter-end date (2024-03-31), the same without dashes, or a quarter label (2024Q1). Omit for to_date alone. | |
| max_assets | No | Maximum total assets in that quarter, thousands of US dollars; applied to each quarter's report. | |
| min_assets | No | Minimum total assets in that quarter, thousands of US dollars (1000000 = $1 billion); applied to each quarter's report. | |
| sort_order | No | desc (default, largest first) or asc; applies to sort_by. Rows without a value sort last. | desc |
| metric_filters | No | Up to 5 metric thresholds, all of which a row must meet. A threshold on a capital ratio or insured_deposit_share skips filers that did not report it. Each filtered metric is added to metrics. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | The limit applied to the preview. | |
| rows | No | Inline preview of the panel, sorted as requested. | |
| error | No | Present when the call failed. Absent on success. | |
| shown | No | Rows in the preview. | |
| notice | No | Guidance for zero matches, a capped panel, or where the full panel is staged. | |
| dataset | No | The staged full panel; present only when the panel exceeded the preview and this deployment staged it as a dataframe. | |
| truncated | No | True when the preview holds fewer rows than were fetched. | |
| data_as_of | No | When FDIC last rebuilt the financials index (ISO timestamp). | |
| report_dates | No | Quarter range as applied. | |
| rows_fetched | No | Rows fetched into the panel. | |
| panel_row_cap | No | This server's row cap for one panel. | |
| total_matching | No | Institution-quarter rows at FDIC matching the filters. | |
| panel_truncated | No | True when total_matching exceeded the panel row cap. Whole quarters are kept newest first, so a truncated panel is missing its oldest quarters — or, when the newest quarter alone exceeds the cap, the higher-numbered CERTs of that quarter. | |
| metric_definitions | No | Field, unit, and basis of each metric in rows. | |
| report_dates_defaulted | No | True when neither from_date nor to_date was given, so only the latest published quarter was covered. |