This API provides detailed information on cyclones. It delivers real-time data on location, pressure, speed, and other related metrics, making it useful for cyclone monitoring, analysis, and forecasting.
Authentication
The Weather API uses Basic Authorization on Swagger UI.
Authentication Steps
1.
Click the [Authorize] button in the top right corner.
2.
Enter the provided username and password in the pop-up window.
3.
Click [Authorize] again to proceed with authentication.
4.
After successful login, click [Close] to close the window.
All API requests from Swagger UI will automatically include the authorization token.
Weather Cyclone Request
Request URL
[GET] https://insight.seavantage.com/api/weather/cyclone
Execution Steps
1.
2.
Navigate to the /weather/cyclone endpoint.
3.
Click [Try it Out] to activate input fields.
4.
Enter the required request parameter:
•
Source: Set the source field to specify the provider of cyclone-related information.
Cyclone Source | Description |
JTWC | Joint Typhoon Warning Center |
NOAA | National Oceanic and Atmospheric Administration |
5.
Click [Execute].
6.
View results in the response section.
Response Information
Sample Response Format
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"cycloneName": "string",
"cycloneNumber": 0,
"basin": "string",
"details": [
{
"dateTime": "2025-05-15T00:44:11.133Z",
"fixHour": 0,
"latitude": 0,
"longitude": 0,
"pressure": 0,
"speed": 0
}
],
"geoJson": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
50,
-10,
0
]
},
"properties": {
"name": "SOME CYCLONE",
"visibility": true,
"open": true,
"description": "",
"Style": {
"description": {
"title": null,
"abstract": null
},
"name": "name",
"transformation": null,
"options": {},
"featureInstanceIDs": null,
"onlineResource": null,
"rules": []
}
},
"id": "abc-aaaaaaaa_18dc1a851c8_-abcd"
}
]
}
}
]
}
JavaScript
복사
Response Field Descriptions
Top-Level Response Fields
Field | Example Value | Description |
code | 200 | Response status code (used in the same way as standard HTTP status codes).
See the list of codes below for reference. |
message | success | Response message (description based on status) |
error | false | Error flag
true: error occurred
false: successful processing |
timestamp | 2025-05-15T10:56:59.034880881 | Time of response creation (UTC) |
response | null or Object | Returns cargo data if found
Returns null if not found |
Response Codes
Code | Description |
200 | Success |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |
Detailed Response Description
Depth 1 Field Description (response object)
Field | Example | Description |
cycloneName | string | Cyclone name |
cycloneNumber | 0 | Cyclone number |
basin | string | Cyclone formation basin
(area where cyclones form) |
Depth 2 Field Description (details object)
Field | Example | Description |
dateTime | 2025-05-15T00:53:12.606Z | Cyclone formation time |
fixHour | 0 | Cyclone duration |
latitude | 0 | Latitude |
longitude | 0 | Longitude |
pressure | 0 | Cyclone pressure |
speed | 0 | Cyclone speed |
Depth 3 Field Description (geoJson object)
Field | Example | Description |
type | FeatureCollection | geoJson type |
Field | Example | Description |
type | Feature | Individual spatial object |
type | Point | Spatial (location) data type |
coordinates | 50, -10, 0 | Coordinates |
Field | Example | Description |
name | SOME CYCLONE | Name of the geographic object |
visibility | true | Map display status
true: Displayed on the map
false: Hidden on the map |
open | true | Editability |
description | Typhoon center point | Description of the properties field |
Field | Example | Description |
title | Cyclone Style | Style name |
abstract | Style description for the specific cyclone feature | Style description |
Field | Example | Description |
name | CycloneStyleAlpha | Style name |
transformation | rotate(45) | Style visual or coordinate transformation information |
options | “color”: “red”, “opacity”: 0.8, “lineWidth”: 2 | Style configuration options |
featureInstanceIDs | fc1, fc2, fc3 | Unique identifier (ID) of the feature instance |
onlineResource | http://example.com/styling/resource | External resources linked to the style |
rules | “ruleName: “VisibilityRule”, “condition”: “visibility == true”, “action”: “display” | Conditional logic of the style |
Field | Example | Description |
id | abc-aaaaaaaa_18dc1a851c8_-abcd | Type (geospatial data format) unique identifier |