/shorttermforecasthistorydates#
Warning
Deprecation Notice for Hyperion API v3 - We are deprecating Hyperion API v3 to concentrate on the improved functionality of newer versions. V3 will no longer receive new features or enhancements.
New Integrations: Please use Hyperion API v4.
Existing v3 Users: We encourage you to migrate to v4.
SynMax will provide migration guides and proactive support to assist with your transition.
This endpoint returns the available forecast run dates for the shortterm forecast history.
Warning
A throttling mechanism with a rate limit of 30 requests per minute has been implemented for this endpoint. This is temporary and may be adjusted in the future.
Endpoint#
GET |
https://hyperion.api.synmax.com/v3/shorttermforecasthistorydates |
Usage#
Python#
- client.short_term_forecast_history_dates()#
Returns available forecast run dates for the shortterm forecast history.
This function takes no parameters.
Object returned is a pandas DataFrame.
Note
To learn how to setup and use Python client, refer to Setup and Usage .
Response#
Parameter |
Type |
Description |
Example |
|---|---|---|---|
forecast_run_date |
string |
Date of nearest forecast (unsynced). Date formatting - [“YYYY-MM-DD”] |
“2022-06-01” |
Responses#
Normal Output#
forecast_run_date |
|---|
2024-10-24 |
2024-10-20 |
2024-10-18 |
2024-10-14 |
2024-10-11 |
2024-10-08 |
Note
Output data will return as “null” when input data is invalid or does not exist.