get_dataset_list: Get list of available datasets

In fanghuiz/legiscanrr: API wrapper for LegiScan

Description

This is the API wrapper function for the getDatasetList operation. It returns a list of available datasets, with optional state and/or year filtering.

Usage

get_dataset_list(state = NULL, year = NULL,
  api_key = legiscan_api_key())

Arguments

state	State filter (optional)
year	Year filter (optional)
api_key	Your LegiScan API key (see legiscan_api_key)

Details

This opertation does not return the dataset itself. Rather, it gives the dataset meta-data, and the session_id and access_key required for the get_dataset function to retrieve the dataset.

• If neither state nor year is given, returns a full list of all available dataset

• If only state is given, returns datasets for that state from all available years

• If only year is given, returns datasets for that year from all 50 states, plus DC and Congress.

Value

List of dataset information.

See Also

get_dataset, legiscan_api_key, LegiScan API manual

fanghuiz/legiscanrr documentation built on Jan. 13, 2020, 4:51 a.m.