Return Structure Monthly Diversion/Release Records
Source:R/get_structures_divrec_ts.R
get_structure_divrecmonth.Rd
Make a request to the api/v2/structures/divrec/divrecmonth/ endpoint to retrieve monthly structure diversion/release data for a specified WDID within a specified date range.
Usage
get_structure_divrecmonth(
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
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 is 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.