query_companies: Suggest Possible Companies based on partial match

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

Suggest Possible Companies based on partial match

Description

API docs: https://cfpb.github.io/api/ccdb/

Usage

query_companies(
  text,
  size = NULL,
  company_public_response = NULL,
  company_received_max = NULL,
  company_received_min = NULL,
  company_response = NULL,
  consumer_consent_provided = NULL,
  consumer_disputed = NULL,
  date_received_max = NULL,
  date_received_min = NULL,
  has_narrative = NULL,
  issue = NULL,
  product = NULL,
  state = NULL,
  submitted_via = NULL,
  tags = NULL,
  timely = NULL,
  zip_code = NULL
)

Arguments

text	required (string) text to use for suggestions
size	(integer) Limit the size of the results
company_public_response	(string array) Filter the results to only return these types of public response by the company
company_received_max	(string) Return results with date < company_received_max (i.e. 2017-03-04)
company_received_min	(string) Return results with date >= company_received_min (i.e. 2017-03-04)
company_response	(string array) Filter the results to only return these types of response by the company
consumer_consent_provided	(string array) Filter the results to only return these types of consent consumer provided
consumer_disputed	(string array) Filter the results to only return the specified state of consumer disputed, i.e. yes, no
date_received_max	(string) Return results with date < date_received_max (i.e. 2017-03-04)
date_received_min	(string) Return results with date >= date_received_min (i.e. 2017-03-04)
has_narrative	(string array) Filter the results to only return the specified state of whether it has narrative in the complaint or not, i.e. yes, no
issue	(string array) Filter the results to only return these types of issue and subissue, i.e. product-only: Getting a Loan, subproduct needs to include product, separated by '•', Getting a Loan•Cant qualify for a loan
product	(string array) Filter the results to only return these types of product and subproduct, i.e. product-only: Mortgage, subproduct needs to include product, separated by '•', Mortgage•FHA mortgage
state	(string array) Filter the results to only return these states (use abbreviation, i.e. CA, VA)
submitted_via	(string array) Filter the results to only return these types of way consumers submitted their complaints
tags	(string array) Filter the results to only return these types of tag
timely	(string array) Filter the results to show whether a response was timely
zip_code	(string array) Zip Code

Value

character vector matching text string

Examples

## Not run: 
  query_companies(text = "chase")

## End(Not run)

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