Access the realtime API

Usage

rtAPI(ID = NULL, measure = NULL)

Arguments

ID: Station Reference ID
measure: Type of measurement required

Value

A data.table of data exported from the EAs realtime API

Examples

## Generate a table of all IDs available
stationIDs <- riskyData::loadAPI("flood")

## Find parameters available
rtAPI(ID = "2001")
#>                                                                                        measID
#>                                                                                        <char>
#> 1:       http://environment.data.gov.uk/flood-monitoring/id/measures/2001-flow--i-15_min-m3_s
#> 2: http://environment.data.gov.uk/flood-monitoring/id/measures/2001-level-stage-i-15_min-mASD
#>    parameter unitName period
#>       <char>   <char>  <int>
#> 1:      flow     m3/s    900
#> 2:     level     mASD    900
## Download flow data
data <- rtAPI(ID = "2001", measure = "flow")
#> ℹ Downloading extended realtime data
#> ✔ Downloading extended realtime data [1.6s]
#> 
plot(data$value, type = 'l')