| get_failures | R Documentation |
Queries the /failures endpoint of the FDIC BankFind Suite API,
returning data for failed financial institutions from 1934 to present.
get_failures(
api_key = Sys.getenv("FDIC_API_KEY"),
filters = NULL,
fields = NULL,
sort_by = NULL,
descending = FALSE,
limit = 10000
)
api_key |
(String) Your FDIC API key. Required: the FDIC does not
accept unauthenticated requests. Defaults to the value of the
|
filters |
(String) An optional Elasticsearch query string to filter results. All field names and values must be uppercase. |
fields |
(String or Character vector) Fields to include in the response.
An |
sort_by |
(String) Field name to sort results by. Defaults to the API default sort order for this endpoint. |
descending |
(Logical) Should results be sorted in descending order?
Only applies when |
limit |
(Integer) Number of records to return. Must be between 1 and 10,000. Defaults to 10,000. |
A tibble containing bank failure data for FDIC-insured institutions, with one row per failure event.
# Return the 5 most recent bank failures
suppressMessages(get_failures(
sort_by = "FAILDATE",
descending = TRUE,
limit = 5
))
# Filter to failures in a single state
suppressMessages(get_failures(
filters = "PSTALP:NY",
limit = 5
))
# Return specific fields only
suppressMessages(get_failures(
fields = c("CERT", "FAILDATE", "NAME", "PSTALP"),
limit = 5
))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.