solarforecastarbiter.io.api.APISession.get_forecast_values

APISession.get_forecast_values(forecast_id, start, end, interval_label=None, request_limit='365D')[source]

Get forecast values from start to end for forecast_id

Parameters:
  • forecast_id (string) – UUID of the forecast object
  • start (timelike object) – Start of the interval to retrieve values for
  • end (timelike object) – End of the interval
  • interval_label (str or None) – If beginning, ending, adjust the data to return only data that is valid between start and end. If None or instant, return any data between start and end inclusive of the endpoints.
  • request_limit (string) – Timedelta string describing maximum request length. Defaults to 365 days.
Returns:

pandas.Series – With the forecast values and a datetime index

Raises:

ValueError – If start or end cannot be converted into a Pandas Timestamp