This API provides a forecast of wind and open ocean swell for multiple places
Please see the Wind-Swell API (single place) page for more detailed information about wind and swell figures.
The URI for the multiple-place wind and swell API looks something like this:
https://tidespy.com/api/windswell2?places=2918,2951&date=20140816&days=2&key=...
This should be mostly self-explanatory.
places is a comma-separated list of Tidespy place numbers.
date is in yyyymmdd format for the starting data of the response.
days is a number of days of data required, between 1 and 7.
key is a Tidespy API key (see front page).
A typical response (ie, that for the URI shown above) can be seen to the right.
All dates and times are local time for the place in question.
Output units are mostly the metric MKS system. Directions are measured in degrees clockwise from North.
Places is an array of wind-swell responses, one object per place requested. Each place in the array contains a forecast object as follows:
PlaceNumber is a requested place number, and PlaceName is the name of the place that corresponds to the number. Returned as a visual double-check that the correct place has been requested.
WsLat and WsLong give the position of the wind-swell location itself, along with its ID (WsNumber) and name (WsName) which again is a visual cross-check. Names refer to the general sea area, are derived from a nearby place, and are therefore somewhat approximate.
Dates is an array the same size as the number of days requested. Values for dates and times beyond the last date computed by NOAA will be empty.
Date is for one day's worth of data, in yyyymmdd format.
0000 - 2100 are the local times for the place in expressed as hhmm.
The value names are mostly NOAA standard symbols, as follows:
WDIR - wind direction, degrees CW from North.
WIND - wind speed (metres/sec)
DIRPW - Direction of the primary (biggest) wave in degrees.
PERPW - Period of the primary wave (seconds, peak-to-peak).
HTSGW - Height (m) of the significant wave - the combined swell height.
WindText and SwellText are a human-readable summary for the whole day. The units for these are presently fixed at metric.
The WindSwell data is produced 3-hourly, with 0000 at midnight plus the other seven comprising a full day. These times are the object names, and are always the same eight times.
Times may start at one of the 3-hour times other than 0000 because that's how the JSON encoder produces the output. All eight times for the day will be present though the sequence may be unusual.
A typical response as it appears in a browser is shown below. Some repetitious sub-trees are collapsed (the ones with a +) to keep the size down and make it easier to see the structure.
Note: This browser is Chrome with the JSONView extension from the Google Chrome App Store. A JSON viewer is a useful tool to have.