Forecast a single series and return median and quantile paths.
How to run this route from Python with the Ouro SDK.
API access requires an API key. Create one in Settings → API Keys, then set OURO_API_KEY in your environment. Install the SDK with pip install ouro-py.
POST /forecastParameters and request body schema for this route.
Pandas offset alias for the series ('MS' month start, 'QS', 'D', 'W-SUN'). Inferred from dates when omitted.
Label for the series, echoed back in the response.
ISO dates aligned one-to-one with values. When supplied, forecast rows are dated by extending the series frequency.
Historical observations, oldest first. At most 15360 points are used; longer histories are truncated to the most recent window. Gaps are rejected rather than filled — decide how to handle a missing observation before asking for a forecast.
Range: 1 to 1024
Steps to forecast.
Named covariates known only over the history. Each must have the same length as values.
Named covariates known over history and forecast window, such as a calendar or a published projection. Each must have length len(values) + horizon.
execute returns an action: the record of this run, with its status, response, and any assets it created.
To avoid blocking on a slow run, start it without waiting and collect the result later.
By default a failed run comes back as an action with status error. Pass raise_on_error=True to raise an exception instead.
Every run is saved as an action. List yours, or read the logs of a single run. See the Python SDK reference for everything an action carries.
import os
from ouro import Ouro
ouro = Ouro(api_key=os.environ.get("OURO_API_KEY"))
# The ID also works, and stays the same if the route is renamed: "9693eaa2-0302-4340-bb73-4b02eddcb9bd"
route = ouro.routes.retrieve("chronos/forecast")
action = route.execute(
body={
"values": [],
},
)
print(action.status) # "success" or "error"
print(action.final_data)# Returns as soon as the run is accepted
action = route.execute(
body={
"values": [],
},
wait=False,
)
print(action.id, action.status)
# Later, even from another process
action = ouro.routes.poll_action(str(action.id), poll_interval=5, timeout=1800)
print(action.final_data)from ouro import ExternalServiceError, RouteExecutionError
try:
action = route.execute(
body={
"values": [],
},
raise_on_error=True,
)
except ExternalServiceError as exc:
# The API behind this route failed
print(exc.status_code, exc.retryable)
except RouteExecutionError as exc:
print(exc.action_id, exc.status, exc.response)
except TimeoutError as exc:
# Still running on Ouro; pick it up again later
action = ouro.routes.poll_action(exc.action_id, timeout=None)route = ouro.routes.retrieve("chronos/forecast")
# Your runs of this route
actions = route.read_actions()
for action in actions:
print(action.id, action.status, action.created_at)
# One run and its logs
action = ouro.routes.retrieve_action("your-action-id")
for entry in action.read_logs(chronological=True):
print(entry.level, entry.message)Execution
Usage
12 callsView history