get_all_complaints: Get all CFPB complaints

In bertcarnell/cfpb.api: CFPB API for Public Data

Get all CFPB complaints

Description

Get all CFPB complaints

Usage

get_all_complaints(quiet = TRUE, file = NA)

Arguments

quiet	Should progress messages be printed?
file	if NA, the file will be downloaded. If a file exists, it will be read and transformed. If the file does not exist, it will be created.

Value

A data frame:

tags

Data that supports easier searching and sorting of complaints submitted by or on behalf of consumers.

zip_code

string

complaint_id

string

issue

factor The issue the consumer identified in the complaint

date_received

POSIXlt The date the CFPB received the complaint

state

factor

consumer_disputed

factor Whether the consumer disputed the company’s response

product

factor The type of product the consumer identified in the complaint

has_narrative

boolean

company_response

factor

company

string The complaint is about this company

submitted_via

factor How the complaint was submitted to the CFPB

date_sent_to_company

POSIXlt The date the CFPB sent the complaint to the company

company_public_response

string The company's optional, public-facing response to a consumer's complaint

sub_product

factor The type of sub-product the consumer identified in the complaint

timely

factor Whether the company gave a timely response

complaint_what_happened

string Consumer complaint narrative is the consumer-submitted description of "what happened" from the complaint.

sub_issue

factor The sub-issue the consumer identified in the complaint

consumer_consent_provided

factor Identifies whether the consumer opted in to publish their complaint narrative.

Examples

## Not run: 
  test <- get_all_complaints()

## End(Not run)

bertcarnell/cfpb.api documentation built on June 2, 2025, 6:09 a.m.