• More

API Response Reference

Field Type Description

Public Name

 Public Description
timestamp Unix Timestamp GMT unix time for the start of this forecast period. This forecast will cover the period until the start of the next available forecast. This is typically three hours for much of our data.
localTimestamp Unix Timestamp Unix timestamp adjusted to represent local time for this location. Convert this to a date and time for display purposes unless you specifically want GMT/ZULU time.
issueTimestamp Unix Timestamp GMT unix time for the start of this forecast. Although we call it the 'issue' time it'll always actually become available after this time because we need to create or obtain the model data and prepare it for delivery.
fadedRating Number The total number of faded stars for our surf rating.
solidRating Number The total number of solid stars for our surf rating. MUST always be combined with fadedRating to give an overall rating.
threeHourTimeText String Localised version of the forecast time.
swell.minBreakingHeight Number Lower end of the likely range for breaking wave size on this beach. Intelligently rounded. Use this for text display.
swell.absMinBreakingHeight Number Lower end of the likely range for breaking wave size on this beach. Absolute value. Use this for smooth graphing.

swell.maxBreakingHeight

 Number Upper end of the likely range for breaking wave size on this beach. Intelligently rounded. Use this for text display.
swell.absMaxBreakingHeight Number Upper end of the likely range for breaking wave size on this beach. Absolute Value. Use this for smooth graphing.
swell.probability Number % chance of the swell being in the forecast range.
swell.unit String Unit string that can be appended to heights for display.
swell.components[].height Number Significant Wave Height. The average of the largest third of all waves in this swell. Comparable to normal readings of height from another computer forecast, wave buoy or trained human observer. Intelligently rounded for display dependent on units.
swell.components[].absHeight Number As above with no rounding.
swell .components[].period Number Peak Period of this swell component. NB. Average period is used by some systems in some context (eg. UKMO Wave buoys) and isn't directly comparable. Peak period is the period at which the swell spectra has the most energy and is commonly abbreviated to 'period' when used by surfers.
swell.components[].direction Number Average direction of waves in this swell.
swell.components[].compassDirection String Cardinal point for the average direction of waves in this swell.
swell.components[].isIncoming Boolean Is this swell heading towards the beach? If false it will likely have no impact on surf size.
wind.speed Number Wind speed
wind.direction Number Wind direction
wind.compassDirection String Cardinal point for wind direction

wind.chill

 Number Estimated 'feels like' temperature based on air temperature and wind speed.
wind.gusts Number Wind Gust Speed
wind.unit String Unit string that can be appended to heights for display.
condition.temperature Number Air Temperature
condition.weather Number Weather icon number. Absolute URL to weather icons. http://cdnimages.magicseaweed.com/30×30/{{ICON NUMBER}}.png.
condition.pressure Number Mean Sea Level Pressure
condition.unitPressure String Display unit for pressure
condition.unit String Display unit for Temperature
charts.swell String Absolute URL to a 750px wide swell chart for this forecast
charts.period String Absolute URL to a 750px wide period chart for this forecast
charts.wind String Absolute URL to a 750px wide wind chart for this forecast
charts.pressure String Absolute URL to a 750px wide pressure chart for this forecast
charts.sst String Absolute URL to a 750px wide sst chart for this forecast