Welcome to pysurfline’s documentation!

Get the surf forecasts for any spot listed on Surfline.

Quickly get the forecast data as a pandas DataFrame and plot surf forecasts with matplotlib to visualize the conditions of your favorite surf spot.

• Waves (wave min and max)

• Wind (speed and direction)

• Swell (height, period, direction)

• Tides (height, direction)

• SunlightTimes (sunrise, sunset)

Warning

This package is not official and not affiliated with Surfline in any way.

API responses may change at any time and the developement of this package may not be able to keep up with those changes.

If you find any issues, please open an issue or submit a pull request.

Examples

• Quickstart
  • Retriving the spotId of a Surfline spot
  • Getting the Surfline forecast of a spot
  • SpotForecast
  • Get data as pandas Dataframe
• Visualize the surf report
• Surfline API
  • pysurfline Objects

Code reference

pysurfline

python Surfline API

Indices and tables

• Index

• Module Index

• Search Page