List Custom Emission Factors

const options = {
  method: 'GET',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'x-user-id': '<x-user-id>'
  }
};

fetch('https://api.dcycle.io/api/v1/custom_emission_factors/list/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dcycle.io/api/v1/custom_emission_factors/list/{id}"

headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "x-user-id": "<x-user-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

curl --request GET \
  --url https://api.dcycle.io/api/v1/custom_emission_factors/list/{id} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --header 'x-user-id: <x-user-id>'

GET

api

custom_emission_factors

list

{id}

List Custom Emission Factors

const options = {
  method: 'GET',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'x-user-id': '<x-user-id>'
  }
};

fetch('https://api.dcycle.io/api/v1/custom_emission_factors/list/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dcycle.io/api/v1/custom_emission_factors/list/{id}"

headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "x-user-id": "<x-user-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

curl --request GET \
  --url https://api.dcycle.io/api/v1/custom_emission_factors/list/{id} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --header 'x-user-id: <x-user-id>'

List Custom Emission Factors

Retrieve all custom emission factors within a specific Custom Emission Group with pagination support.

Request

Headers

string

required

Your API key for authenticationExample: sk_live_1234567890abcdef

string

required

Your organization UUIDExample: ff4adcc7-8172-45fe-9cf1-e90a6de53aa9

string

required

Your user UUIDExample: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Path Parameters

string

required

UUID of the Custom Emission Group

Query Parameters

integer

default:"1"

Page number

integer

default:"50"

Items per page (max: 100)

Response

{
  "page": 1,
  "size": 50,
  "total": 15,
  "items": [
    {
      "id": "factor-uuid",
      "ef_name": "Recycled Aluminum - Supplier ABC",
      "unit_id": "kg-unit-uuid",
      "factor_uploaded_by": "sustainability@company.com",
      "tag": "advanced",
      "uncertainty_grade": 15.0,
      "factor_start_date": "2024-01-01",
      "factor_end_date": "2024-12-31",
      "additional_docs": "EPD No. ABC-2024-001",
      "emission_factor_values": [
        {"gas_type": "CO2", "value": 2.15},
        {"gas_type": "CH4", "value": 0.008}
      ],
      "recycled": true
    }
  ]
}

Example

Python

import requests
import os

headers = {
    "Authorization": f"Bearer {os.getenv('DCYCLE_API_KEY')}",
    "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
    "x-user-id": os.getenv("DCYCLE_USER_ID")
}

group_id = "group-uuid"

response = requests.get(
    f"https://api.dcycle.io/api/v1/custom_emission_factors/list/{group_id}",
    headers=headers,
    params={"page": 1, "size": 50}
)

factors = response.json()
print(f"Total factors: {factors['total']}")

for factor in factors['items']:
    co2_value = next(v['value'] for v in factor['emission_factor_values'] if v['gas_type'] == 'CO2')
    print(f"- {factor['ef_name']}: {co2_value} kg CO2/{factor['unit_id']}")

Create Factor

Add new factor

Get Factor

View factor details

Create Custom Emission Factor Get Custom Emission Factor

Introduction

Logistics

Facilities

Vehicles

Purchases

Wastes

Reference Data

Custom Emission Factors

Custom Emission Groups

List Custom Emission Factors

List Custom Emission Factors

Request

Headers

Path Parameters

Query Parameters

Response

Example

Create Factor

Get Factor

​List Custom Emission Factors

​Request

​Headers

​Path Parameters

​Query Parameters

​Response

​Example

​Related Endpoints

Create Factor

Get Factor

List Custom Emission Factors

Request

Headers

Path Parameters

Query Parameters

Response

Example

Related Endpoints