Giter VIP home page Giter VIP logo

spitcast-api-docs's Introduction

Spitcast API Documentation

Terms of use

  1. Use at your own risk. I can't guarantee that the API will always be up, and sometimes the structure of requests and responses will change.
  2. Predicting the future is hard. Sometimes forecasts won't be accurate. I constantly make improvements to the core algorithm, largely based on issues in the existing one.
  3. If you make use of Spitcast's data in a public way, please provide attribution. It doesn't need to be a big mention. Just mention it somewhere.
  4. Whatever you build, please don't call it Spitcast. For example, if your name is Jimmy and you build an Android app, don't name it Spitcast in the Play Store. Name it something like "Jimmy's Surf App" and then mention that it's powered by Spitcast in the description or something.
  5. Share what you've built. I love seeing the different ways this data can be used.

Endpoints

Surf Spots

This is a (growing) list of California surf spots where Spitcast provides forecasts.

https://api.spitcast.com/api/spot

Surf Forecast

This provides surf forecasts for a given surf spot. These are generated by Spitcast. The structure of the request is: /{spot_id}/{year}/{month}/{day}. In the response, the shape values equate to 0.0 = Poor, 0.5 = Poor-Fair, 1.0 = Fair, >1.0 = Good

https://api.spitcast.com/api/spot_forecast/1/2023/3/14

Swell Forecast

This provides regional swell information from NOAA's WAVEWATCH III. The structure of the request is: /{county_id}/{year}/{month}/{day}

https://api.spitcast.com/api/buoy_ww3/1/2023/3/14

Wind Forecast

This provides wind information from NOAA's National Digital Forecast Database. The structure of the request is: /{county_id}/{year}/{month}/{day}

https://api.spitcast.com/api/buoy_ndfd/1/2023/3/14

Tide Forecast

This provides tide information from NOAA's Tides & Currents. The structure of the request is: /{county_id}/{year}/{month}/{day}

https://api.spitcast.com/api/buoy_tide/1/2023/3/14

Current Water Temperature

This provides wind information from NOAA's National Data Buoy Center. The structure of the request is: /{county_id}/{year}/{month}/{day}

https://api.spitcast.com/api/buoy_ndbc/1/2023/3/14

spitcast-api-docs's People

Contributors

jackmullis avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

allanbutler

spitcast-api-docs's Issues

Rating Scale clarification

Glad to see you have an open API again! I'm excited to dig into it for Meta Surf Forecast. I just wanted to clarify how you describe the rating scale:

0.0 = Poor, 0.5 = Poor-Fair, 1.0 = Fair, 1.5+ = Good

Does that mean that shape values can exceed 1.5, or is that the max value?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.