https://github.com/mhelmetag/surflinef

An API client for fetching data from the Surfline API v1 and v2
https://github.com/mhelmetag/surflinef

api forecasts surfing surfline tides

Last synced: 4 months ago
JSON representation

An API client for fetching data from the Surfline API v1 and v2

• Host: GitHub
• URL: https://github.com/mhelmetag/surflinef
• Owner: mhelmetag
• License: gpl-3.0
• Created: 2018-02-08T08:51:43.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-07-25T20:45:09.000Z (almost 4 years ago)
• Last Synced: 2025-05-17T09:21:06.402Z (about 1 year ago)
• Topics: api, forecasts, surfing, surfline, tides
• Language: Go
• Homepage:
• Size: 68.4 KB
• Stars: 70
• Watchers: 4
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SurflineF

[![Build Status](https://travis-ci.org/mhelmetag/surflinef.svg?branch=master)](https://travis-ci.org/mhelmetag/surflinef)

An API client for fetching Forecasts from the Surfline API.

Check out the `v2` folder for the API client for the Surfline API v2.

## Installation

Simply run `go get github.com/mhelmetag/surflinef` and start using it in your own apps!

**Note:** I believe any go version over 1.11 will get upset with how I do my weird JSON unmarshalling (because of Surfline's weird API data types). I would recommend using v2 anyways...

## Usage

The full example for fetching a Forecast (and other info) can be found in `examples/main.go` and can be run with `go run examples/main.go`.

## Surfline API URL

`http://api.surfline.com/v1/forecasts`

## Known Query Params

- **resources (string)** - Possible values: \[surf, analysis, wind, weather, tide, sort\] (optional resources for forecast)

- **days (integer)** - Greater than 1 (unsure of upper limit; confirmed to go above 10 but data usually becomes unknown/blank after that)

- **getAllSpots (boolean)** - _true_ will get all spot forecasts in the subregion (meaning an array of forecasts)

- **aggregate (boolean)** - _true_ enables aggregate fields for the Surf resource

- **units (string)** - Possible values: \[e, m\] (e is feet and m is meters)

- **fullAnalysis (boolean)** - _true_ adds fields like `brief_outlook`, `best_bet`, `extended_outlook` and others to the larger Analysis JSON object

- **showOptimal (boolean)** - Not sure what this does yet

- **interpolate (boolean)** - Not sure what this does yet

## Example API Calls

Found in the network tab when browsing around the Surfline site:

`http://api.surfline.com/v1/forecasts/2141?&callback=jQuery18001517130109550182_1474259459851&resources=resources%3Dwind%2Csurf%2Canalysis%2Cweather%2Ctide%2Csort&days=17&aggregate=true&units=e&_=1474259492858`

`http://api.surfline.com/v1/forecasts/2141?resources=analysis&units=e&days=1&fullAnalysis=true`

`http://api.surfline.com/v1/forecasts/2141?resources=surf,analysis&days=1&getAllSpots=true&units=e&interpolate=false&showOptimal=false`

`http://api.surfline.com/v1/forecasts/4991?resources=surf&days=1&getAllSpots=false&units=e&interpolate=true&showOptimal=false`