ustfd_tables {ustfd} | R Documentation |
Return a table of supported and known tables including the API endpoints
for the specified dataset(s). See ustfd_datasets()
for known datasets.
Description
ustfd_tables
provides details about 85 known endpoints for Fiscal Data.
A data frame with 85 rows and the following 9 columns:
-
dataset
- ID of the source dataset -
endpoint
- the table's API endpoint (natural key) -
table_name
- Name of the table within the data set -
table_description
- a description for the data in the endpoint -
row_definition
- a description of what each row in the table describes -
path_name
- API path name -
date_column
- the name of the table column that holds the record's date -
earliest_date
- the date of the earliest record available for this table -
update_frequency
- "Daily", "Monthly", "Quarterly", "Semi-Annually", "Annually", "As Needed", "Daily (Discontinued)", "Monthly (Discontinued)"
Usage
ustfd_tables(datasets = NULL)
Arguments
datasets |
one or more strings representing a valid dataset ID. If present, only endpoints belonging to matching datasets will be returned |
Value
tibble
Source
https://fiscaldata.treasury.gov/api-documentation/#list-of-endpoints
See Also
Other ustfd_user:
endpoint_exists()
,
ustfd_all_pages()
,
ustfd_datasets()
,
ustfd_query()
,
ustfd_simple()
,
ustfd_table_columns()
Examples
library(ustfd)
ustfd_tables(ustfd_datasets()$dataset[2])$endpoint