The maritime API endpoint delivers essential global marine weather data, including wave and swell heights, directions, and periods, tidal and surge information, surface ocean currents, sea surface temperature, and significant wave height. This comprehensive data set is available hourly by default, with options for 3-hour, 6-hour, or other defined intervals, making it suitable for a variety of maritime applications, such as oceanic navigation, offshore operations, coastal monitoring, and recreational activities.
The Maritime endpoint provides access to a wide array of information, including the following:
The following actions are supported with the maritime endpoint:
:id | Requesting data by using the :id action is used for returning data for a particular item that has an ID associated with it. This is the primary method for requesting general weather information for a single location (observations, forecasts, advisories, etc.) as the location's name or a zip code serves as the id. Other endpoints may expect a certain value for the ID, such as storm cells whose ID value is a combination of the radar site identifier and unique identifier assigned to every storm cell. Refer to an endpoint's detailed documentation for specific information regarding how to use the :id action. |
route | The route action returns data for points along a given route. This can be useful to obtain weather information along a transportation route, trails and more. The route is a series of locations, usually latitude/longitudes provided via the p query parameter or for longer routes via GeoJSON within a POST request. The route will return an array of GeoJSON points with the requested data for each point. |
The following parameters are optional unless otherwise noted:
p | p=:place |
Defines the location to query data for. Refer to the list of supported place value formats. |
for | for=:string |
Returns the results starting for the time frame specified. The for parameter is an alias of the from , but useful to indicate a specific time versus a time rangeSupports a UNIX timestamp or a specific date string. Alternatively, common date formats supported by the PHP strtotime() function will be accepted; however, commas are not accepted. Examples: for=tomorrow for=friday for=1302883980 for=MM/DD/YYYY for=YYYY/MM/DD for=+2hours for=2017-02-27 5:00 PM |
from | from=:string |
Returns the results starting from the value specified. For best practices we recommend using the to parameter as well to define a specific time frame.Supports a UNIX timestamp or a specific date string. Alternatively, common date formats supported by the PHP strtotime() function will be accepted; however, commas are not accepted. Examples: from=tomorrow from=friday from=1302883980 from=MM/DD/YYYY from=YYYY/MM/DD from=+2hours from=2017-02-27 5:00 PM |
to | to=:string |
Returns the results between now and the value specified. For best practices we recommend using the from parameter as well to define a specific time frame. When used in conjunction with the from parameter, the value of to will be relative to the value of from, not relative to the current time. Supports a UNIX timestamp or a specific date string. Alternatively, common date formats supported by the PHP strtotime() function will be accepted; however, commas are not accepted. Examples: to=+6hours to=+5days to=1302883980 to=MM/DD/YYYY to=YYYY/MM/DD to=2017-02-27 5:00 PM |
plimit | plimit=:total |
Applied only on the periods property, the total number of periods to return as an integer. The maximum plimit for this endpoint is 250. |
pskip | pskip=:number |
Applied only on the periods property, used to skip over a specific number of periods in the data set. |
psort | psort=:string |
Applied only on the periods property, used to sort results based on certain fields contained within the periods. |
filter | filter=:string |
Predefined filters for limiting the results. The filter value can be a single, comma-delimited or a semicolon delimited string of filter names. |
The following filters can be passed to the filter parameter to reduce the results that are returned:
#hr | Returns the conditions in # hour intervals for up to a 24 hour period. # must be an integer from 1 to 24. For example: filter=1hr : 1 hour intervals (Default) filter=3hr : 3 hour intervals filter=6hr : 6 hour intervals. This filter is often be used in combination with the from and to parameters. If no from and to the endpoint returns data for the next 24 hours. |
Default Sort: dt:1 (Date time ascending)
You can use the following fields to sort data. Review the sorting docs page for more information on the sort functionality.
dt | Sort based on the forecast date/time |
The /[:endpoint]/[:action]?
portion within the query template below can be exchanged with any of the examples. Also, please note you will need to input your client credentials in the [ID]
and [SECRET]
fields which can be found under the Apps section of the members area.
https://api.aerisapi.com/[:endpoint]/[:action]?client_id=[ID]&client_secret=[SECRET]
Returns the maritime forecast in hourly intervals for the next 24 hours for latitude/longitude 0,0/maritime/0,0
Returns the estimated maritime conditions for the current hour at latitude/longitude 0,0/maritime/0,0?for=now&to=now
Returns the maritime forecast in hourly intervals for the next 48 hours for latitude/longitude 0,0/maritime/0,0?for=now&to=+48hours
Returns the maritime forecast in 6 hour intervals for the next 7 days for latitude/longitude 0,0/maritime/0,0?for=now&to=+1week&filter=6hours
The following is an example of what each object in the response will consist of. Depending on your requested action, the response may contain multiple instances of this object within an array.
{
"loc": {
"long": 0,
"lat": 0
},
"interval": "1hr",
"periods": [
{
"timestamp": 1682204400,
"dateTimeISO": "2023-04-22T23:00:00+00:00",
"seaSurfaceTemperatureC": 28.7,
"seaSurfaceTemperatureF": 83.66,
"seaCurrentSpeedKTS": 0.4347,
"seaCurrentSpeedKPH": 0.805,
"seaCurrentSpeedMPS": 0.2236,
"seaCurrentSpeedMPH": 0.5002,
"seaCurrentDir": "NNW",
"seaCurrentDirDEG": 333,
"significantWaveHeightM": 1.36,
"significantWaveHeightFT": 4.4619,
"significantWaveDir": null,
"significantWaveDirDEG": null,
"significantWavePeriod": null,
"primaryWaveDir": "SSW",
"primaryWaveDirDEG": 211,
"primaryWavePeriod": 12,
"primarySwellHeightM": 0.7,
"primarySwellHeightFT": 2.2966,
"primarySwellDir": "SSW",
"primarySwellDirDEG": 212,
"primarySwellPeriod": 12,
"secondarySwellHeightM": 0.2,
"secondarySwellHeightFT": 0.6562,
"secondarySwellDir": "S",
"secondarySwellDirDEG": 170,
"secondarySwellPeriod": 13,
"tertiarySwellHeightM": 0.11,
"tertiarySwellHeightFT": 0.3609,
"tertiarySwellDir": "SSW",
"tertiarySwellDirDEG": 205,
"tertiarySwellPeriod": null,
"tidesM": -0.56,
"tidesFT": -1.8373,
"surgeM": 0.02,
"surgeFT": 0.0656,
"windWaveDirDEG": 192,
"windWaveDir": "S",
"windWavePeriod": 8
}
],
"profile": {
"tz": "Africa/Accra",
"elevFT": 0,
"elevM": 0
}
}
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
0,
0
]
},
"properties": {
"loc": {
"long": 0,
"lat": 0
},
"interval": "1hr",
"periods": [
{
"timestamp": 1682204400,
"dateTimeISO": "2023-04-22T23:00:00+00:00",
"seaSurfaceTemperatureC": 28.7,
"seaSurfaceTemperatureF": 83.66,
"seaCurrentSpeedKTS": 0.4347,
"seaCurrentSpeedKPH": 0.805,
"seaCurrentSpeedMPS": 0.2236,
"seaCurrentSpeedMPH": 0.5002,
"seaCurrentDir": "NNW",
"seaCurrentDirDEG": 333,
"significantWaveHeightM": 1.36,
"significantWaveHeightFT": 4.4619,
"significantWaveDir": null,
"significantWaveDirDEG": null,
"significantWavePeriod": null,
"primaryWaveDir": "SSW",
"primaryWaveDirDEG": 211,
"primaryWavePeriod": 12,
"primarySwellHeightM": 0.7,
"primarySwellHeightFT": 2.2966,
"primarySwellDir": "SSW",
"primarySwellDirDEG": 212,
"primarySwellPeriod": 12,
"secondarySwellHeightM": 0.2,
"secondarySwellHeightFT": 0.6562,
"secondarySwellDir": "S",
"secondarySwellDirDEG": 170,
"secondarySwellPeriod": 13,
"tertiarySwellHeightM": 0.11,
"tertiarySwellHeightFT": 0.3609,
"tertiarySwellDir": "SSW",
"tertiarySwellDirDEG": 205,
"tertiarySwellPeriod": null,
"tidesM": -0.56,
"tidesFT": -1.8373,
"surgeM": 0.02,
"surgeFT": 0.0656,
"windWaveDirDEG": 192,
"windWaveDir": "S",
"windWavePeriod": 8
}
],
"profile": {
"tz": "Africa/Accra",
"elevFT": 0,
"elevM": 0
}
}
}
]
}
The following properties will be provided in every response object:
Last modified: June 09, 2023