Responses
Understanding the forecast API response
TimeseriesResponse
All forecast and historical data endpoints return a standardized TimeseriesResponse object. This format efficiently represents matrix-like timeseries data with parallel arrays for timestamps and values, optimized for client-side processing and visualization.
All timeseries data uses the period-beginning convention. This is in contrast to the common “hour ending” convention often used by ISOs.
Structure
Fields
Reading the values matrix
The values matrix is organized series-first:
- Outer index corresponds to series —
values[j]is the full timeseries forcolumns[j] - Inner index corresponds to timestamps —
values[j][i]is the value forcolumns[j]attime_utc[i]
For example, given the response above:
Working with the TimeSeriesResponse
The response structure makes it easy to convert directly to a pandas DataFrame.
Python
Null values
Some data points may be null in the values matrix. This occurs when:
- Data is not yet available for a future timestamp
- A specific series does not have coverage for the full time range
- The source data has gaps or reporting delays
Always handle null values in your client code when processing the response.
