Environmental Footprint API

The Environmental Footprint API offers tools that help monitor your environmental impact using Scaleway's services.

Calculation

Refer to our dedicated Environmental Footprint calculation breakdownOpen in new context documentation page for more information on how we measure your environmental footprint.

Quickstart

1. Configure your environment variables.

   Code
   export SCW_ORGANIZATION_ID=<your-organization-ID>
   export SCW_SECRET_KEY="<secret-key>"

2. Run the query below to retrieve a list of available reports:

   Code
   curl \
   -H "X-Auth-Token: ${SCW_SECRET_KEY}" \
   "https://api.scaleway.com/environmental-footprint/v1alpha1/reports/availability?\
   organization_id=${SCW_ORGANIZATION_ID}&\
   start_date=<start-date>"

   You can add the following parameters to your endpoint:

   Parameter	Description
   organization_id	REQUIRED Your organization ID.
   start_date	REQUIRED The start date of the query period. The date should not be before 2024-10-01. The date should follow the ISO 8601 format. For example: 2025-07-01T00:00:00Z.
   end_date	The end date of the query period. Defaults to the current day if not set.

3. Run the query below to retrieve a specific impact report.

   Code
   curl \
     -H "X-Auth-Token: ${SCW_SECRET_KEY}" \
     -d "{
       \"organization_id\": \"${SCW_ORGANIZATION_ID}\",
       \"type\": \"<report-type>\",
       \"date\": \"<report-date>\"
     }" \
     "https://api.scaleway.com/environmental-footprint/v1alpha1/reports/download" \
     | jq -r '.content' \
     | base64 -d \
     > /tmp/report.pdf

   You can add the following parameters to your endpoint:

   Parameter	Description
   organization_id	REQUIRED Your organization ID.
   date	REQUIRED The date of the requested report. The date should not be before 2024-10-01.
   type	The report type. Can be monthly or yearly.

4. Open the report.

   ```bash xdg-open /tmp/report.pdf ``` ```bash open /tmp/report.pdf ```

5. Run the query below to retrieve specific impact data for your Organization. You can add the parameters of your choice in the endpoint to filter the query by project ID, region, zone, service category, and/or product category. In the example below we retrieve the impact data of all Elastic Metal servers in the Organization.

   Code
   curl -H "X-Auth-Token: ${SCW_SECRET_KEY}" "https://api.scaleway.com/environmental-footprint/v1alpha1/data/query?organization_id=${SCW_ORGANIZATION_ID}&start_date=<start_date>&product_categories=elastic_metal"

   Parameter	Description
   organization_id	REQUIRED Your organization ID.
   start_date	The start date of the query period. The date should not be before 2024-10-01.
   product_categories	List of product categories of the products for which you want to retrieve impact data. Example: elastic_metal.

   Tip

   Refer to the Retrieve detailed impact data endpoint reference for an extensive list of available parameters and corresponding values.

   If the request was successful you will see a response like the following:

   Code
   {
     "start_date": "2025-07-01T00:00:00Z",
     "end_date": "2025-07-04T00:00:00Z",
     "total_impact": {
       "kg_co2_equivalent": 2.453914,
       "m3_water_usage": 0.016715
     },
     "projects": [
       {
         "project_id": <project_id>,
         "total_project_impact": {
           "kg_co2_equivalent": 2.453914,
           "m3_water_usage": 0.016715
         },
         "regions": [
           {
             "region": "fr-par",
             "total_region_impact": {
               "kg_co2_equivalent": 2.453914,
               "m3_water_usage": 0.016715
             },
             "zones": [
               {
                 "zone": "fr-par-2",
                 "total_zone_impact": {
                   "kg_co2_equivalent": 2.453914,
                   "m3_water_usage": 0.016715
                 },
                 "skus": [
                   {
                     "sku": "/baremetal/em-a115x-ssd/monthly/run_par2",
                     "total_sku_impact": {
                       "kg_co2_equivalent": 2.058405,
                       "m3_water_usage": 0.003345
                     },
                     "service_category": "baremetal",
                     "product_category": "elastic_metal"
                   }
                 ]
               }
             ]
           },
         ]
       }
     ]
   }

   The response gives you the estimated impact for the projects, regions, zones, service categories, and product categories that match your filters.