Description Usage Format Details Total_Params Total_Usage Params Aggregate_Params Usage Aggregate_Usage References Examples
A class to create Failure queries to the FDIC API. Derived
from class fdic_base
.
1 |
An object of class R6ClassGenerator
of length 24.
Example filters
Filter by Location: CITYST:"MEMPHIS, TN"
Filter by institution fail year range: FAILYR:["2015" TO "2016"]
Example fields: NAME,CERT,FIN,CITYST,FAILDATE,SAVR,RESTYPE,RESTYPE1,QBFDEP,QBFASSET,COST
Example sort_by: FAILDATE
total_fields
Fields to sum up (in a totals response object). Only numeric columns are valid.
subtotal_by
The field by which data will be subtotaled (in totals response object). Only categorical values should be used.
fdic_failures$setTotal_fields(total_fields)
fdic_failures$setSubtotal_by(subtotal_by)
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
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
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)
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)
https://banks.data.fdic.gov/docs/
1 2 3 4 5 | if (curl::has_internet()) {
x <- fdic_failures$new()
x$get_available_fields()
x$get_available_field_description("FAILDATE")
}
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.