spot: Get spot information from the Spitcast API

In sboysel/spitcastr: An R client for Spitcast Surf Forecast API

Description

Get spot information from the Spitcast API

Usage

spot(item = "all", spot_id = NULL, ...)

Arguments

item	The name of the specific spot data item as a string. Must must be one of 'all', 'forecast', 'nearby', 'neighbors', 'top', or 'search'. Required. Default is 'all'.
spot_id	The spot ID to query, as an integer. Required for the 'forecast', and 'neighbors' items. Default is NULL.
...	Any additional parameters passed to specific data items. For example, the 'neighbors' item takes an optional 'direction' parameter.

Examples

spot(item = "all")
spot(item = "nearby")
spot(item = "search", size_min = 1, shape_min = 1, distance = 10)
spot(item = "neighbors", spot_id = 1, direction = "above")
spot(item = "forecast", spot_id = 1)

sboysel/spitcastr documentation built on May 29, 2019, 3:25 p.m.