Return Structure Yearly Diversion/Release Records — get_structure

Make a request to the api/v2/structures/divrec/divrecyear/ endpoint to retrieve annual structure diversion/release data for a specified WDID within a specified date range.

Usage

get_structure_divrecyear(
  wdid = NULL,
  wc_identifier = NULL,
  start_date = "1900-01-01",
  end_date = Sys.Date(),
  api_key = NULL
)

Arguments

wdid: character vector or list of characters indicating WDID code of structure
wc_identifier: wc_identifier character, series of water class codes that provide the location of the diversion, the SOURCE of water, the USE of the water and the administrative operation required to make the diversion. Provide "diversion" or "release" to retrieve diversion/release records. Default is NULL which will return diversions records.
start_date: character date to request data start point YYYY-MM-DD. Default start date is "1900-01-01".
end_date: character date to request data end point YYYY-MM-DD. Default end date is the current date the function is run.
api_key: character, optional. If more than maximum number of requests per day is desired, an API key can be obtained from CDSS.

Value

dataframe with yearly structure data for the CDSS structure of interest