solarforecastarbiter.io.api.APISession.chunk_value_requests

APISession.chunk_value_requests(api_path, start, end, parse_fn, params={}, request_limit='365D')[source]

Breaks up a get requests for values into multiple requests limited by the request_limit argument.

Parameters:
  • api_path (str) –
  • start (pandas.Timestamp) –
  • end (pandas.Timestamp) –
  • parse_fn (function) – A function used to parse json api response into a pandas Series or DataFrame.
  • params (dict) – Any additional parameters to be passed with the get function.
  • request_limit (string) – Timedelta string describing maximum request length. Defaults to 365 days.
Returns:

all_data (pandas.DataFrame or pandas.Series) – The concatenated results of each request when parsed by parse_fn.