Get Forecast Cone | Silurian Docs

from silurian import Earth
import datetime
client = Earth(
    api_key="YOUR_API_KEY_HERE",
)
client.cyclones.forecasts.cone(
    storm_id="storm_id",
    time=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
    max_lead_time="max_lead_time",
    smooth_cone=True,
    model="OFCL",
)

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "GeometryCollection",
        "geometries": [
          {
            "type": "LineString",
            "coordinates": [
              []
            ]
          }
        ]
      },
      "properties": {
        "key": "value"
      },
      "id": 1
    }
  ],
  "bbox": [
    {
      "key": "value"
    }
  ]
}

Get cyclone forecast cone in GeoJSON format

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

storm_idstringRequired

Query parameters

timedatetimeOptional

Default value: (current time) - Default time zone: UTC

max_lead_timestringOptional

Value must be > P0D

smooth_conebooleanOptionalDefaults to true

modelenumOptionalDefaults to GFTC

Allowed values:

Response

Successful Response

type"FeatureCollection"

featureslist of objects

bboxlist of any

Errors

401

Forecasts Cone Request Unauthorized Error

404

Forecasts Cone Request Not Found Error

422

Forecasts Cone Request Unprocessable Entity Error

500

Forecasts Cone Request Internal Server Error