Dark mode
/v2/weather-on-track.xml
POST
/v2/weather-on-track.xml
Obtain weather data interpolated to global ship route waypoints.
POST a list of (date, lat, lon) points and receive weather values at each location.
| Item | Value |
|---|---|
| Format | XML |
| Region | Global |
| Method | POST (JSON body) |
| Max Points | 100 per request |
| Average Size | ~25 KB |
| Forecast Base Time | 00:00, 06:00, 12:00, 18:00 UTC |
| Data Update Time | Forecast Base Time + ~7 h (tmp1000hpa: +~8 h) |
| NIL Value | −9999999 |
Data Elements
| No | Code | Name | Unit |
|---|---|---|---|
| 1 | sigwh | Significant wave height | m |
| 2 | awp | Average wave period | s |
| 3 | pwh | Primary wave height | m |
| 4 | pwd | Primary wave direction (16-dir, Coming From) | degree number |
| 5 | pwp | Primary wave period | s |
| 6 | pswh | Swell wave height | m |
| 7 | pswd | Swell wave direction (16-dir, Coming From) | degree number |
| 8 | pswp | Swell wave period | s |
| 9 | wsh | WindSea wave height | m |
| 10 | wsd | WindSea wave direction (16-dir, Coming From) | degree number |
| 11 | wsp | WindSea wave period | s |
| 12 | swh | Secondary wave height | m |
| 13 | swd | Secondary wave direction (16-dir, Coming From) | degree number |
| 14 | swp | Secondary wave period | s |
| 15 | ocs | Ocean current speed | knot |
| 16 | ocd | Ocean current direction (16-dir, Going To) | degree number |
| 17 | was | Wind speed | knot |
| 18 | wad | Wind direction (16-dir, Going To) | degree number |
| 19 | wad_come_from | Wind direction (16-dir, Coming From) | degree number |
| 20 | ssp | Sea surface pressure | Pa |
| 21 | tmp1000hpa | Temperature at 1000 hPa | °C |
| 22 | sst | Sea surface temperature | °C |
| 23 | date | Date and time of point | yyyymmddhh |
| 24 | lat | Latitude of point | minute |
| 25 | lon | Longitude of point | minute |
Forecast Specifications
| Elements | Duration | Time Pitch |
|---|---|---|
| 1–14 (wave) | 384 h | 3 h |
| 15–16 (ocean current) | 696 h | 24 h |
| 17–20 (wind, pressure) | 384 h | 6 h |
| 21 (tmp1000hpa) | 354 h ¹ | 6 h |
| 22 (sst) | — | — |
¹ tmp1000hpa has a shorter forecast range (354 h) and becomes available ~1 hour later than other elements.
Past Data
| Elements | Duration | Time Pitch |
|---|---|---|
| 1–14 | 5 years | 3 h |
| 15–16 | 5 years | 24 h |
| 17–21 | 5 years | 6 h |
| 22 | 5 years | — |
Grid Region
| Elements | Latitude | Longitude | Resolution |
|---|---|---|---|
| 1–14, 17–21 | −90.0 to 90.0 (Δ1.0°) | 0.0 to 359.0 (Δ1.0°) | 1.0° |
| 15–16 (ocean current) | −78.0 to 80.0 (Δ0.125°) | 0.0 to 359.875 (Δ0.125°) | 0.125° |
| 22 (sst) | −89.5 to 89.5 (Δ1.0°) | 0.5 to 359.5 (Δ1.0°) | 1.0° |
Past Data
For past base times, only the analysis data (t000) is retained; forecast timesteps that
have become historical are deleted. When querying past dates, data is interpolated from
the nearest available analysis run.
Parameters
Header Parameters
Authorization*
"WniWebApi " + Token ID
Typestring
RequiredRequest Body
JSON
{
"Point": [
{
"date": 0,
"lat": 0,
"lon": 0
}
]
}
Responses
Successful response with weather data at each requested point.
application/xml
JSON
"<?xml version="1.0"?>
<Point>
<date>0</date>
<lat>0</lat>
<lon>0</lon>
<sigwh>0</sigwh>
<pwh>0</pwh>
<pwd>0</pwd>
<pswh>0</pswh>
<pswd>0</pswd>
<wsh>0</wsh>
<wsd>0</wsd>
<ocs>0</ocs>
<ocd>0</ocd>
<was>0</was>
<wad>0</wad>
<wad_come_from>0</wad_come_from>
<ssp>0</ssp>
<tmp1000hpa>0</tmp1000hpa>
<sst>0</sst>
<pswp>0</pswp>
<awp>0</awp>
<swh>0</swh>
<swd>0</swd>
<swp>0</swp>
<pwp>0</pwp>
<wsp>0</wsp>
</Point>
"