/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#

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.