fdic_locations: FDIC API Query for Locations

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

FDIC API Query for Locations

Description

A class to create Locations 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: RUNDATE:["2015-01-01" TO "2015-01-06"]

• Filter for office number between 0 and 10: OFFNUM:[0 TO 10]

• Filter for branches in Oregon with type 11: STNAME:Oregon AND SERVTYPE:11

Example fields: NAME,UNINUM,SERVTYPE,RUNDATE,CITY,STNAME,ZIP,COUNTY Example sort_by: NAME

Value

an object of type fdic_sod

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_locations

Methods

Public methods

• fdic_locations$new()

• fdic_locations$query_fdic()

• fdic_locations$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_locations$new()

---

Method query_fdic()

Query FDIC API

Usage

fdic_locations$query_fdic()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

fdic_locations$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_locations$new()
  x$get_available_fields()
  x$get_available_field_description("CBSA")
}

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