/shorttermforecasthistorydates

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

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.

⮞ Setup the client.

from synmax.hyperion import HyperionApiClient, ApiPayload
access_token = 'your access token goes here'
client = HyperionApiClient(access_token=access_token)

For a more detailed guide on setting up the Hyperion client, please see the Quickstart page.

⮞ Call the function.

result_df = client.short_term_forecast_history_dates()

⮞ Print the results or save them for later.

# Print the entire response as a string.
print(result_df.to_string())

# Create a CSV file from the output.
result_df.to_csv('output.csv')

# Print the number of items per column.
print(result_df.count())

For more information on outputting to different formats, please see the pandas DataFrame documentation.

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.