Dark Mode
/v2/port-forecast-gsf.json
GET
/v2/port-forecast-gsf.json
GSF Port Forecast Specification
| No | Item | Value |
|---|---|---|
| 1 | Data Name | GSF Port Forecast |
| 2 | Data Area | Global |
| 3 | Data Output Format | JSON |
| 4 | Data Update | 02:00, 08:00, 14:00, 20:00 UTC |
| No | Item Name | Full Name | Unit/Format | Values Type |
|---|---|---|---|---|
| 1 | data | - | - | - |
| 2 | base_time | Forecast Base Date time | datetime (yyyy-mm-ddThh:mm:ssZ) | string |
| 3 | valid_date | Forecast Date Time | datetime (yyyy-mm-ddThh:mm:ssZ) | string |
| 4 | WNDSPD | Wind Velocity | 1 kts | int |
| 5 | GUSTS | Gust Wind Velocity | 1 kts | int |
| 6 | WNDDIR | Wind Direction | 16 cardinal directions | int |
| 7 | WX | Weather Condition | - | int |
| 8 | PRCRIN_3HOUR_TOTAL | Precipitation for 3 hours | 1 mm / 3hrs | int |
| 9 | HVIS | Visibility | 1 m | int |
| 10 | AIRTMP | Air Temperature | 1 deg | int |
| 11 | ARPRSS | Pressure | 1 hPa | int |
| 12 | CLING | Cloud Base Height | 1 ft | int |
| 13 | SGFDIR | Wave Direction | 16 cardinal directions | int |
| 14 | SGFHGT | Wave Height | 1 m | int |
| 15 | SGFHGT_Max | Wave Height Max | 1 m | int |
| 16 | SGFPER | Wave Period | 1 s | int |
| 17 | SWLHGT | Swell Height | 1 m | int |
| 18 | SWLDIR | Swell Direction | 16 cardinal directions | int |
| 19 | SWLPER | Swell Period | 1 s | int |
| 20 | SEWHGT | Wind Sea Height | 1 m | int |
| 21 | SEWDIR | Wind Sea Direction | 16 cardinal directions | int |
| 22 | SEWPER | Wind Sea Period | 1 s | int |
| 23 | PWVHGT | Primary Height | 1 m | int |
| 24 | PWVDIR | Primary Direction | 16 cardinal directions | int |
| 25 | PWVPER | Primary Period | 1 s | int |
| 26 | SWVHGT | Secondary Height | 1 m | int |
| 27 | SWVDIR | Secondary Direction | 16 cardinal directions | int |
| 28 | SWVPER | Secondary Period | 1 s | int |
| 29 | RHUM | Relative Humidity | 1 % | int |
| 30 | DEWTMP | Dew point temperature | 1 s | int |
| 31 | INDEX_CNDNS | Index condensation | none | - |
Telop Chart
| Code | Telop Chart |
|---|---|
| 100 | Sunny |
| 200 | Cloudy |
| 300 | Rain |
| 430 | Sleet |
| 400 | Snow |
| 700 | Mist |
| 2001 | Light Sand/Dust Storm |
| 2002 | Moderate Sand/Dust Storm |
| 2003 | Severe Sand/Dust Storm |
16 Cardinal Directions
| Number | Direction |
|---|---|
| 16 | N |
| 1 | NNE |
| 2 | NE |
| 3 | ENE |
| 4 | E |
| 5 | ESE |
| 6 | SE |
| 7 | SSE |
| 8 | S |
| 9 | SSW |
| 10 | SW |
| 11 | WSW |
| 12 | W |
| 13 | WNW |
| 14 | NW |
| 15 | NNW |
Parameters
Query Parameters
area*
Port Code (Based on port code provided in the point list API)
Typestring
Requireddatetime
Base Time (Format: YYYYMMDDHH, if omitted returns latest)
Typestring
Responses
200 response
application/json
JSON
{
"base_time": "2021-07-05T00:00:00Z",
"data": [
{
"SWVHGT": 7,
"AIRTMP": 25,
"SWLPER": 15,
"ARPRSS": 1015,
"WNDDIR": 12,
"PRCRIN_3HOUR_TOTAL": 0,
"WX": 200,
"SEWDIR": 12,
"SGFPER": 11,
"PWVHGT": 12,
"SWVDIR": 12,
"GUSTS": 16,
"WNDSPD": 10,
"HVIS": 10000,
"SEWHGT": 6,
"PWVDIR": 9,
"CLING": 1100,
"DEWTMP": 22,
"valid_date": "2021-07-05T00:00:00Z",
"SWLDIR": 9,
"SEWPER": 3,
"SGFDIR": 8,
"SWVPER": 3,
"SWLHGT": 13,
"SGFHGT_Max": 23,
"INDEX_CNDNS": 1,
"RHUM": 84,
"SGFHGT": 14,
"PWVPER": 15
}
],
"units": [
{
"comment": "Wind velocity",
"unit": "1 kts",
"name": "WNDSPD"
}
]
}