fdic_institutions: FDIC API Query for Institutions

In bertcarnell/fdic.api: API to the US FDIC Data

FDIC API Query for Institutions

Description

A class to create Institutions queries to the FDIC API. Derived from class fdic_base.

Details

Example filters

• Filter by State name: STNAME:"West Virginia"

• Filter for any one of multiple State names: STNAME:("West Virginia","Delaware")

• Filter by last updated within an inclusive date range: DATEUPDT:["2010-01-01" TO "2010-12-31"]

• Filter for deposits over 50,000,000 (50000 thousands of dollars): DEP:[50000 TO *]

• Filter for active banks in Indiana: STALP:IA AND ACTIVE:1

Example fields: ZIP,OFFDOM,CITY,COUNTY,STNAME,STALP,NAME,ACTIVE,CERT,CBSA,ASSET,NETINC,DEP,DEPDOM,ROE,ROA,DATEUPDT,OFFICES Example sort_by: OFFICES

Value

an object of type fdic_institutions

an object containing metadata and a data.frame

Params

field

one of the available query fields returned by get_available_fields

filters

the filter for the bank search.

fields

Comma delimited list of fields to search

sort_by

Field name by which to sort returned data

sort_order

Indicator if ascending (ASC) or descending (DESC)

limit

The number of records to return. Default is 10 and maximum is 10,000.

offset

The offset of page to return

Usage

fdic_base$get_available_fields()

Get the fields available for queries

fdic_base$get_available_field_description(field)

Get the description of a field

fdic_base$setFilters(filters)

fdic_base$setFields(fields)

fdic_base$setSort_by(sort_by)

fdic_base$setSort_order(sort_order)

fdic_base$setLimit(limit)

fdic_base$setOffset(offset)

Super class

fdic.api::fdic_base -> fdic_institutions

Methods

Public methods

• fdic_institutions$new()

• fdic_institutions$query_fdic()

• fdic_institutions$clone()

Inherited methods

• fdic.api::fdic_base$fdic_api()
• fdic.api::fdic_base$get_available_field_description()
• fdic.api::fdic_base$get_available_fields()
• fdic.api::fdic_base$parse_yaml()
• fdic.api::fdic_base$setFields()
• fdic.api::fdic_base$setFilters()
• fdic.api::fdic_base$setLimit()
• fdic.api::fdic_base$setOffset()
• fdic.api::fdic_base$setSort_by()
• fdic.api::fdic_base$setSort_order()

---

Method new()

Initialization Method

Usage

fdic_institutions$new()

---

Method query_fdic()

Query FDIC API

Usage

fdic_institutions$query_fdic()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

fdic_institutions$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

References

https://banks.data.fdic.gov/docs/

Examples

if (curl::has_internet()) {
  x <- fdic_institutions$new()
  x$get_available_fields()
  x$get_available_field_description("CBSA")
  
  x <- fdic_institutions$new()
  x$setFilters("STALP:OH AND ACTIVE:1")
  x$setFields(c("ZIP","OFFDOM","CITY","COUNTY","STNAME","STALP","NAME","ACTIVE",
                "CERT","CBSA","ASSET","NETINC","DEP","DEPDOM","ROE","ROA",
                "DATEUPDT","OFFICES"))
  x$setSort_by("OFFICES")
  x$setLimit(100)
  res <- x$query_fdic()
  dim(res$data)
}

bertcarnell/fdic.api documentation built on June 18, 2024, 3:19 a.m.