fdic_base: FDIC API Query Base Class

Description Usage Format Params Usage References Examples

Description

A base class, from which specific queries are derived. This class can be used directly for a user-derived query

Usage

1

Format

An object of class R6ClassGenerator of length 24.

Params

path

The path off of the base FDIC API URL that directs the type of query

query

A list of query elements passed to the web API

Usage

fdic_base$fdic_api(path, query)

Query using the FDIC API

References

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
if (curl::has_internet()) {
  x <- fdic_base$new()
  resp <- x$fdic_api("/api/institutions", 
    list(filters = "STALP:OH AND ACTIVE:1",
      fields = "ZIP,OFFDOM,CITY,COUNTY,STNAME,STALP,NAME,ACTIVE,CERT,CBSA,ASSET",
      sort_by = "ZIP",
      sort_order = "DESC",
      limit = 10,
      offset = 0,
      format = "json",
      download = "false",
      filename = "data_file"))
}

bertcarnell/fdic.api documentation built on May 12, 2021, 2:53 a.m.