Get Summary of Deposits branches and market share
fdic_get_depositsRead-onlyIdempotent
Get Summary of Deposits data (branch-level domestic deposits, annual as of June 30, 1994 onward). With cert only: the institution's branches and its deposit market share in each state where it has offices. With a geography (state, county, city, ZIP, or MSA code): every institution in that market ranked by deposits, with market share and the Herfindahl-Hirschman index. With both: the institution's branches in that market and its rank and share there. Defaults to the latest survey year. Dollar amounts are in thousands.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| zip | No | Five-digit branch ZIP code; leading zeros kept (02110). | |
| cert | No | FDIC certificate number, from fdic_search_institutions. Alone: its branches and per-state share. With a geography: its position in that market. | |
| city | No | Branch city as FDIC spells it (Seattle, St. Louis), up to 50 characters; matched exactly as given or in title case, with a hyphen, apostrophe, or space between words also tried the other ways FDIC records it (Winston-Salem finds Winston Salem); requires state. | |
| year | No | Survey year (deposits as of June 30), 1994 on. Omit for the latest survey. | |
| limit | No | Branches or ranked institutions returned inline (1–200). A larger set is also staged whole as a dataframe when this deployment stages dataframes. | |
| state | No | Branch state: two-letter code in any case or full name. | |
| county | No | County as FDIC spells it (King, not King County — a trailing " County" is stripped), up to 50 characters; matched exactly as given or in title case, with a hyphen, apostrophe, or space between words also tried the other ways FDIC records it; requires state. | |
| msa_code | No | Five-digit CBSA (metropolitan area) code, 10180–49740; branch rows from a state-level call carry msa_code values to reuse. Non-metropolitan branches have no code. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | The limit applied to the preview. | |
| mode | No | institution (cert only), market (geography only), or institution_in_market (both). | |
| year | No | Survey year (deposits as of June 30). | |
| error | No | Present when the call failed. Absent on success. | |
| shown | No | Rows in the preview. | |
| market | No | Market modes: the whole market in the geography. | |
| notice | No | Guidance when nothing matched, or where the full collection is staged. | |
| dataset | No | The staged full collection; present only when it exceeded the preview and this deployment staged it as a dataframe. | |
| branches | No | Institution modes: branches in scope, main office first (preview). | |
| position | No | institution_in_market: present when the institution has branches in the market. | |
| footprint | No | Institution mode: its deposits and share per state, largest first. | |
| geography | No | The geography as applied; absent in institution mode. | |
| truncated | No | True when the preview holds fewer rows than total_rows. | |
| data_as_of | No | When FDIC last rebuilt the Summary of Deposits index (ISO timestamp). | |
| total_rows | No | Full count of the branches (institution modes) or ranked institutions (market). | |
| institution | No | The institution; present when it reported branches in scope. | |
| institutions | No | Market mode: institutions ranked by deposits (preview). | |
| year_defaulted | No | True when year was omitted and the latest survey was used. |