dot-fdic_doc_function: Documentation function

In bertcarnell/fdic.api: API to the US FDIC Data

Documentation function

Description

Documentation function

Usage

.fdic_doc_function()

Usage

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)

Aggregate_Usage

fdic_locations$setAgg_by(agg_by)

fdic_locations$setAgg_term_fields(agg_term_fields)

fdic_locations$setAgg_sum_fields(agg_sum_fields)

fdic_locations$setAgg_limit(agg_limit)

Params

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

Aggregate_Params

agg_by

The field(s) by which data will be aggregated. Valid values are 'YEAR' or 'YEAR,STNAME'.

agg_term_fields

The field(s) for which aggregations will be counted for each unique term.

agg_sum_fields

The field(s) for which aggregations will be summed or aggregated.

agg_limit

The limit on how many aggregated results will be displayed

bertcarnell/fdic.api documentation built on June 18, 2024, 3:19 a.m.