└── README.md


/README.md:
--------------------------------------------------------------------------------
 1 | # Spitcast API Documentation
 2 | 
 3 | ## Endpoints
 4 | 
 5 | ### Surf Spots
 6 | 
 7 | This is a (growing) list of California surf spots where Spitcast provides forecasts.
 8 | 
 9 | https://api.spitcast.com/api/spot
10 | 
11 | ### Surf Forecast
12 | 
13 | 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`
14 | 
15 | https://api.spitcast.com/api/spot_forecast/1/2023/3/14
16 | 
17 | 
18 | ### Swell Forecast
19 | 
20 | This provides regional swell information from NOAA's [WAVEWATCH III](https://polar.ncep.noaa.gov/waves/wavewatch/).  The structure of the request is: `/{county_id}/{year}/{month}/{day}`
21 | 
22 | 
23 | https://api.spitcast.com/api/buoy_ww3/1/2023/3/14
24 | 
25 | ### Wind Forecast
26 | 
27 | This provides wind information from NOAA's [National Digital Forecast Database](https://graphical.weather.gov/).  The structure of the request is: `/{county_id}/{year}/{month}/{day}`
28 | 
29 | https://api.spitcast.com/api/buoy_ndfd/1/2023/3/14
30 | 
31 | 
32 | ### Tide Forecast
33 | 
34 | This provides tide information from NOAA's [Tides & Currents](https://tidesandcurrents.noaa.gov/).  The structure of the request is: `/{county_id}/{year}/{month}/{day}`
35 | 
36 | https://api.spitcast.com/api/buoy_tide/1/2023/3/14
37 | 
38 | 
39 | ### Current Water Temperature
40 | 
41 | This provides wind information from NOAA's [National Data Buoy Center](https://www.ndbc.noaa.gov/).  The structure of the request is: `/{county_id}/{year}/{month}/{day}`
42 | 
43 | https://api.spitcast.com/api/buoy_ndbc/1/2023/3/14
44 | 
45 | ## Terms of use
46 | 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.
47 | 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.
48 | 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.
49 | 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.
50 | 5. Share what you've built.  I love seeing the different ways this data can be used.
51 | 


--------------------------------------------------------------------------------