ustfd_table_columns: Return a table of known fields for known endpoints

In ustfd: API Client for US Treasury Fiscal Data

Return a table of known fields for known endpoints

Description

ustfd_table_columns returns the column dictionaries for the specified endpoint(s). See ustfd_tables() for known endpoints.

Usage

ustfd_table_columns(endpoints = NULL)

Arguments

endpoints

one or more strings representing a valid endpoint

Details

The format of a dictionary is a tibble with one row for every table column and the following columns:

• endpoint - the ID of the table this column belongs to

• colum_name - the field name recognizable to the API interface

• data_type - one of: "DATE", "STRING", "CURRENCY", "NUMBER", "PERCENTAGE", "YEAR", "QUARTER", "MONTH", "DAY"

• pretty_name - a descriptive label

• definition - definition of the colmn's value

• is_required - logical value

Value

tibble

Source

https://fiscaldata.treasury.gov/api-documentation/#fields-by-endpoint

See Also

Other ustfd_user: endpoint_exists(), ustfd_all_pages(), ustfd_datasets(), ustfd_query(), ustfd_simple(), ustfd_tables()

Examples

library(ustfd)
ustfd_table_columns(ustfd_tables(ustfd_datasets()$dataset[2])$endpoint)

ustfd documentation built on Nov. 8, 2023, 1:07 a.m.