fdic_summary: FDIC API Query for Summary Information

Description Usage Format Details Params Aggregate_Params Usage Aggregate_Usage References Examples

Description

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

Usage

1

Format

An object of class R6ClassGenerator of length 24.

Details

Example filters

Example fields: STNAME,YEAR,INTINC,EINTEXP,NIM,NONII,NONIX,ELNATR,ITAXR,IGLSEC,ITAX,EXTRA,NETINC Example sort_by: YEAR

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

Aggregate_Params

agg_by

The field(s) by which data will be aggregated. Valid values are 'YEAR' or 'YEAR,STNAME'.

agg_term_fields

The field(s) for which aggregations will be counted for each unique term.

agg_sum_fields

The field(s) for which aggregations will be summed or aggregated.

agg_limit

The limit on how many aggregated results will be displayed

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)

Aggregate_Usage

fdic_locations$setAgg_by(agg_by)
fdic_locations$setAgg_term_fields(agg_term_fields)
fdic_locations$setAgg_sum_fields(agg_sum_fields)
fdic_locations$setAgg_limit(agg_limit)

References

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

Examples

1
2
3
4
5
if (curl::has_internet()) {
  x <- fdic_summary$new()
  x$get_available_fields()
  x$get_available_field_description("INTINC")
}

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