Quick Start Guide
🎯 API - Basic Usage
Get carbon intensity forecast for your region to schedule jobs when renewable energy is most available:
GET /forecast?areaCode=BE
This returns ranked time periods indicating when energy is cleanest in your area.
🔧 API - Advanced Queries
Query by specific data provider and areaCode for more control:
GET /forecast?dataProvider=ENTSO-E&areaCode=DE
Use external identifiers for precise area selection:
GET /forecast?dataProvider=ENTSO-E&externalCode=NO1
📊 API - Response Format
The API returns time periods ranked by carbon intensity (0 = cleanest):
"intensityForecast": [
{
"periodStartAt": "2025-01-15T14:00:00Z",
"periodEndAt": "2025-01-15T15:00:00Z",
"rank": 0
}, ...
]
📅 Carbon-Aware Scheduled Jobs
Schedule jobs with carbon awareness by adding time margins to your:
CarbonAware.at(now().with(nextWorkingDayAt3am), Duration.ofHours(3));
This schedules the job the next working day around 3 AM and but it may run up to 3H earlier or later.
⏰ Carbon-Aware Recurring Jobs
Schedule recurring jobs with carbon awareness by adding time margins to your CRON expressions:
0 2 * * * [PT1H/PT7H]
This runs the job between 1 AM and 9 AM when carbon intensity is lowest.
Getting Started
2. Integrate the API
Use our simple REST API to fetch carbon intensity forecasts and optimize your job scheduling.
View Documentation →3. Reduce Your Impact
Schedule compute-intensive tasks during periods of clean energy availability.
Learn More →