Optional
configuration: ConfigurationThis endpoint takes a batch of requests for historical forecast data, fetches them, and calculates the optimal marginal carbon intensity windows for each using the same parameters available to the '/emissions/forecasts/current' endpoint. This endpoint is useful for back-testing what one might have done in the past, if they had access to the current forecast at the time.
Optional
emissionsForecastBatchParametersDTO: EmissionsForecastBatchParametersDTO[]Array of requested forecasts.
Optional
options: RawAxiosRequestConfigOverride http request option.
This endpoint is useful for reporting the measured carbon intensity for a specific time period in a specific location.
The location name where workflow is run
The time at which the workflow we are measuring carbon intensity for started
The time at which the workflow we are measuring carbon intensity for ended
Optional
options: RawAxiosRequestConfigOverride http request option.
The application only supports batching across a single location with different time boundaries. If multiple locations are provided, an error is returned. For each item in the request array, the application returns a corresponding object containing the location, time boundaries, and average marginal carbon intensity.
Optional
carbonIntensityBatchParametersDTO: CarbonIntensityBatchParametersDTO[]Array of inputs where each contains a "location", "startDate", and "endDate" for which to calculate average marginal carbon intensity.
Optional
options: RawAxiosRequestConfigOverride http request option.
String array of named locations
Optional
time: string[Optional] Start time for the data query.
Optional
toTime: string[Optional] End time for the data query.
Optional
options: RawAxiosRequestConfigOverride http request option.
This endpoint fetches only the most recently generated forecast for all provided locations. It uses the "dataStartAt" and "dataEndAt" parameters to scope the forecasted data points (if available for those times). If no start or end time boundaries are provided, the entire forecast dataset is used. The scoped data points are used to calculate average marginal carbon intensities of the specified "windowSize" and the optimal marginal carbon intensity window is identified. The forecast data represents what the data source predicts future marginal carbon intensity values to be, not actual measured emissions data (as future values cannot be known). This endpoint is useful for determining if there is a more carbon-optimal time to use electricity predicted in the future.
String array of named locations
Optional
dataStartAt: stringStart time boundary of forecasted data points.Ignores current forecast data points before this time. Defaults to the earliest time in the forecast data.
Optional
dataEndAt: stringEnd time boundary of forecasted data points. Ignores current forecast data points after this time. Defaults to the latest time in the forecast data.
Optional
windowSize: numberThe estimated duration (in minutes) of the workload. Defaults to the duration of a single forecast data point.
Optional
options: RawAxiosRequestConfigOverride http request option.
String named location.
Optional
time: string[Optional] Start time for the data query.
Optional
toTime: string[Optional] End time for the data query.
Optional
options: RawAxiosRequestConfigOverride http request option.
String array of named locations
Optional
time: string[Optional] Start time for the data query.
Optional
toTime: string[Optional] End time for the data query.
Optional
options: RawAxiosRequestConfigOverride http request option.
CarbonAwareApi - object-oriented interface
Export
CarbonAwareApi