Skip to content

An R package to communicate with the FDIC web API

License

Notifications You must be signed in to change notification settings

bertcarnell/fdic.api

Repository files navigation

fdic.api

An R package to communicate with the FDIC web API

R-CMD-CHECK Coverage status

Installation

You can install the development version of fdic.api from github with:

if (!require(devtools)) install.packages("devtools")
devtools::install_github("bertcarnell/tornado")

API endpoints

See here for FDIC API Documentation

Implemented Endpoints

  • Institutions
  • Locations
  • History
  • Financials
  • Summary
  • Failures
  • SOD (Summary of Deposits)
  • Demographics

Quick Start

Explore the API

fdic_loc_con <- fdic_locations$new()
fdic_loc_con$get_available_fields()
fdic_loc_con$get_available_field_description("CBSA")

Set API parameters

fdic_loc_con$setLimit(100)
fdic_loc_con$setFilters("STNAME:Texas")

Get Results

results <- fdic_loc_con$query_fdic()
head(results)

About

An R package to communicate with the FDIC web API

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages