carbon_aware_sdk 1.0.0+1

A generated Dart SDK for the Carbon Aware SDK, from the Green Software Foundation.

Carbon Aware SDK

The Carbon Aware SDK exists to enable developers to build Carbon-Aware applications that do more when clean electricity is available, and less when it is not.

Consumption of the SDK requires an API deployment that implements the documented interfaces.

Find out more about the SDK and the Green Software Foundation.

This Dart package was generated by the OpenAPI Generator project.

Documentation for API Endpoints

Class	Method	HTTP request	Description
CarbonAwareApi	batchForecastDataAsync	POST /emissions/forecasts/batch	Given an array of historical forecasts, retrieves the data that contains forecasts metadata, the optimal forecast and a range of forecasts filtered by the attributes [start...end] if provided.
CarbonAwareApi	getAverageCarbonIntensity	GET /emissions/average-carbon-intensity	Retrieves the measured carbon intensity data between the time boundaries and calculates the average carbon intensity during that period.
CarbonAwareApi	getAverageCarbonIntensityBatch	POST /emissions/average-carbon-intensity/batch	Given an array of request objects, each with their own location and time boundaries, calculate the average carbon intensity for that location and time period and return an array of carbon intensity objects.
CarbonAwareApi	getBestEmissionsDataForLocationsByTime	GET /emissions/bylocations/best	Calculate the best emission data by list of locations for a specified time period.
CarbonAwareApi	getCurrentForecastData	GET /emissions/forecasts/current	Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window.
CarbonAwareApi	getEmissionsDataForLocationByTime	GET /emissions/bylocation	Calculate the best emission data by location for a specified time period.
CarbonAwareApi	getEmissionsDataForLocationsByTime	GET /emissions/bylocations	Calculate the observed emission data by list of locations for a specified time period.

Documentation For Models

• CarbonIntensityBatchParametersDTO
• CarbonIntensityDTO
• EmissionsData
• EmissionsDataDTO
• EmissionsForecastBatchParametersDTO
• EmissionsForecastDTO
• ValidationProblemDetails

Author

Green Software Foundation