fdicdata (version 0.1.1)

getInstitution: Retrieve institution data from FDIC API

Description

This function retrieves institution data from the FDIC API based on the specified parameters.

Usage

getInstitution(
  name = NULL,
  IDRSSD_or_CERT = NULL,
  fields,
  IDRSSD = TRUE,
  limit = 10000
)

Value

A data frame containing the institution data.

Arguments

name

(optional) A character string to search for in the institution name.

IDRSSD_or_CERT

IDRSSD or CERT of bank

fields

A character vector of field names to retrieve from the API.

IDRSSD

Default:TRUE functions uses IDRSSD, to using CERT change it FALSE

limit

An integer specifying the maximum number of records to retrieve. Default is 10000.

References

For more information on the FDIC API, visit https://banks.data.fdic.gov/.

Examples

df <- getInstitution(name = "Bank of America", fields = c("NAME", "CITY", "STATE"))