R/get_tides.R

In simon-tarr/uk.tides: A small package to query Admiralty Maritime Data Solutions for data on UK high & low tides

#' Returns high and low tide information for a specified Station ID
#'
#' Returns a \code{tibble} containing data on high and low tides for the specified duration (1 - 7 days)
#'
#' @param api_key a valid Admirality API Key. The function will load in your API key.
#' @param station_id a valid station ID. Can be found by using \code{get_tidal_stations()} or \code{find_closest_tide_station()}
#' @param duration duration in days over which to return tide data. Must be >=1 or <=7.
#' @export
#' @examples
#' find_closest_site(station_id = "0114", duration = 3)

get_tides<-function(api_key, station_id, duration = 1){

  tides<-httr::GET(url = paste0("https://admiraltyapi.azure-api.net/uktidalapi/api/V1/Stations/", station_id, paste0("/TidalEvents?duration="), duration), add_headers("Ocp-Apim-Subscription-Key" = api_key)) %>%
    httr::content(., as="text") %>%
    jsonlite::fromJSON(.)

  return(tides)

}