Get Portfolio Forecasts | Silurian Docs

from silurian import Earth
import datetime
client = Earth(
    api_key="YOUR_API_KEY_HERE",
)
client.portfolios.forecasts(
    portfolio_id="portfolio_id",
    id=[
        "id"
    ],
    variables=[
        "variables"
    ],
    init_time=datetime.datetime.fromisoformat("2024-01-15T09:30:00+00:00"),
)

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "GeometryCollection",
        "geometries": [
          {
            "type": "LineString",
            "coordinates": [
              []
            ]
          }
        ]
      },
      "properties": {
        "datetimes": [
          "2024-01-15T09:30:00Z"
        ],
        "static": {
          "key": "value"
        }
      },
      "id": 1
    }
  ],
  "bbox": [
    {
      "key": "value"
    }
  ]
}

Return a GeoJSON FeatureCollection of forecasts for a portfolio.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

portfolio_idstringRequired

Query parameters

idstringOptionalDefaults to []

variablesstringOptionalDefaults to []

init_timedatetimeRequired

Response

Successful Response

type"FeatureCollection"

featureslist of objects

bboxlist of any

Errors

401

Portfolios Forecasts Request Unauthorized Error

404

Portfolios Forecasts Request Not Found Error

422

Portfolios Forecasts Request Unprocessable Entity Error

500

Portfolios Forecasts Request Internal Server Error