pysurfline.api.client.SurflineClient

class pysurfline.api.client.SurflineClient

Bases: object

surfline client

Surfline API client. At the moment, does not require authentication.

TODO: Login and authentication

Methods

__init__()

get_spot_forecasts(spotId[, intervalHours, days])

create a SpotForecast object from API responses
get_spot_forecasts(spotId: str, intervalHours: Optional[int] = None, days: Optional[int] = None) → SpotForecasts

create a SpotForecast object from API responses

Parameters

  • spotId (str) – spot id

  • intervalHours (int, optional) – interval hours. Defaults to None.

  • days (int, optional) – days. Defaults to None.

Returns

SpotForecast object

Return type

SpotForecast