View source: R/get_financials.R
| get_financials | R Documentation |
Queries the /financials endpoint of the FDIC BankFind Suite API,
returning financial data for FDIC-insured financial institutions.
get_financials(
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.
Defaults to all available fields if not specified. Run |
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. Note: when more than 250 fields are requested, the maximum is 500. |
The /financials endpoint returns one row per institution per reporting
period (quarter). Requesting more than 250 fields reduces the maximum
allowed limit to 500 records; exceeding this will raise an error.
A tibble containing financial data for FDIC-insured institutions, with one row per institution per reporting period.
# Return key financial fields for institutions in New York
suppressMessages(get_financials(
filters = "STALP:NY",
fields = c("ASSET", "CERT", "NETINC", "REPDTE"),
limit = 5
))
# Sort by total assets descending
suppressMessages(get_financials(
fields = c("ASSET", "CERT"),
sort_by = "ASSET",
descending = TRUE,
limit = 5
))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.