eia_query: EIA API Category Query

Description Usage Arguments Value Examples

View source: R/eia.R

Description

A function to pull the available categories in the eia API

Usage

1
eia_query(api_key, category_id = NULL)

Arguments

api_key

A character, the user API key for the eia website

category_id

A character, the category ID as defined in the eia API

Value

A list, with the series metadata

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# Set you eia API key
api_key <- "Set you API key"

# Querying the eia API to get possible categories
eia_query(api_key = api_key) # getting the full list of categories
eia_query(api_key = api_key, category_id = "0") # querying the Electricity category
childseries <- eia_query(api_key = api_key, category_id = "1") # querying the Electricity Net Generation child series

## End(Not run)

RamiKrispin/tsAPI documentation built on Dec. 2, 2019, 11:43 p.m.