Skip to contents

Make a request to the /waterrights/netamount endpoint to retrieve water rights net amounts data via a spatial search or by county, division, water district, or WDID, within a given date range (start and end dates). Returns current status of a water right based on all of its court decreed actions.

Usage

get_water_rights_netamount(
  aoi = NULL,
  radius = NULL,
  county = NULL,
  division = NULL,
  water_district = NULL,
  wdid = NULL,
  api_key = NULL
)

Arguments

aoi

list of length 2 containing an XY coordinate pair, 2 column matrix/dataframe of XY coordinates, sf or Terra SpatVector point/polygon/linestring geometry

radius

numeric, search radius in miles around given point (or the centroid of a polygon). If an AOI is given, radius defaults to 20 miles. If no AOI is given, then default is NULL.

county

character, indicating the county to query

division

numeric, indicating the water division to query

water_district

numeric, indicating the water district to query

wdid

character, indicating WDID code of structure

api_key

character, API authorization token, optional. If more than maximum number of requests per day is desired, an API key can be obtained from CDSS.

Value

dataframe of water right net amounts

Examples

if (FALSE) {
# Water right net amounts within a county
county_net <- get_water_rights_netamount(county = "Adams")

# Water right net amounts within a division
division_net <- get_water_rights_netamount(division = 1)

# Water right net amounts for a WDID
wdid_net <- get_water_rights_netamount(wdid   = "0100555")

# Water right net amounts within a 20 mile search radius
aoi_net <- get_water_rights_netamount(
                  aoi    = data.frame(X = -104.3379, Y = 39.87417),
                  radius = 20
                  )

 }