solarforecastarbiter.io.api.APISession.get_values

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

Get time series values from start to end for object from the API

Parameters:
  • obj (datamodel.Observation, datamodel.Aggregate, datamodel.Forecast, datamodel.ProbabilisticForecastConstantValues) – Data model object for which to obtain time series data.
  • start (timelike object) – Start time in interval to retrieve values for
  • end (timelike object) – End time of the interval
  • interval_label (str or None) – If beginning or ending, return only data that is valid between start and end. If None, 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 or pandas.DataFrame – With a datetime index. If DataFrame, (value, quality_flag) columns
Raises:

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