Description Usage Format Details Params Usage References Examples
A class to create Locations queries to the FDIC API. Derived
from class fdic_base
.
1 |
An object of class R6ClassGenerator
of length 24.
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
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
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)
https://banks.data.fdic.gov/docs/
1 2 3 4 5 | if (curl::has_internet()) {
x <- fdic_locations$new()
x$get_available_fields()
x$get_available_field_description("CBSA")
}
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.