get_locations: Retrieve Financial Institution Locations

In fdic: Interface to 'BankFind Suite API'

Retrieve Financial Institution Locations

Description

Queries the ⁠/locations⁠ endpoint of the FDIC BankFind Suite API, returning location data for FDIC-insured financial institutions.

Usage

get_locations(
  api_key = Sys.getenv("FDIC_API_KEY"),
  filters = NULL,
  fields = NULL,
  sort_by = NULL,
  descending = FALSE,
  limit = 10000
)

Arguments

api_key	(String) Your FDIC API key. Required: the FDIC does not accept unauthenticated requests. Defaults to the value of the FDIC_API_KEY environment variable. Register for a free personal key (1,000 req/hr) at https://api.data.gov/signup/.
filters	(String) An optional Elasticsearch query string to filter results. All field names and values must be uppercase.
fields	(String or Character vector) Fields to include in the response. An ID column is always present, regardless of the fields requested. To retrieve the most recently published API definition for an endpoint, replace the get_ prefix in the function name with fdic_ (e.g., ⁠get_{endpoint}()⁠ to ⁠fdic_{endpoint}()⁠).
sort_by	(String) Field name to sort results by. Defaults to the API default sort order for this endpoint.
descending	(Logical) Should results be sorted in descending order? Only applies when sort_by is specified. Defaults to FALSE.
limit	(Integer) Number of records to return. Must be between 1 and 10,000. Defaults to 10,000.

Value

A tibble containing location data for FDIC-insured institutions, with one row per institution location.

Examples

# Return branch locations in New York
suppressMessages(get_locations(
  filters = "STALP:NY",
  limit = 5
))

# Return specific fields only
suppressMessages(get_locations(
  filters = "STALP:NY",
  fields = c("ADDRESS", "CERT", "CITY", "STALP"),
  limit = 5
))

fdic documentation built on Sept. 12, 2026, 5:09 p.m.