Get Custom Emission Factor

Retrieve detailed information about a specific custom emission factor

GET /api/v1/custom_emission_factors/{id}

Get Custom Emission Factor

JavaScript

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Legacy API. This page documents the previous version of the API. This particular operation has no documented equivalent in the current API yet, so this remains the documented way to do it. Prefer the current API for everything it already covers.

Retrieve complete details of a specific custom emission factor by its ID, including all emission values and associated unit information.

Request

Headers

x-api-key · string · required

Your API key for authentication

Example: sk_live_1234567890abcdef

x-organization-id · string · required

Your organization UUID

Example: ff4adcc7-8172-45fe-9cf1-e90a6de53aa9

x-user-id · string · required

Your user UUID

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Path Parameters

id · string · required

UUID of the Custom Emission Factor

Example: "factor-uuid-here"

Response

Returns the custom emission factor object with complete details including the unit object.

{
  "id": "factor-uuid",
  "factor_id": "factor-uuid",
  "ef_name": "Recycled Aluminum - Supplier ABC",
  "unit_id": "kg-unit-uuid",
  "unit": {
    "id": "kg-unit-uuid",
    "name": "kilogram",
    "abbreviation": "kg",
    "type": "mass"
  },
  "factor_uploaded_by": "[e-mail]",
  "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
    },
    {
      "gas_type": "N2O",
      "value": 0.002
    }
  ],
  "recycled": true,
  "renewable_percentage": null,
  "hazardous": null,
  "low_code": null,
  "rd_code": null
}

Example

cURL

curl "https://api.dcycle.io/api/v1/custom_emission_factors/factor-uuid" \
  -H "Authorization: Bearer ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}" \
  -H "x-user-id: ${DCYCLE_USER_ID}"

Use Cases

Audit and Verification

Retrieve factor details for compliance audits:

factor = requests.get(
    f"https://api.dcycle.io/api/v1/custom_emission_factors/{factor_id}",
    headers=headers
).json()

print(f"Factor: {factor['ef_name']}")
print(f"Source: {factor['additional_docs']}")
print(f"Uploaded by: {factor['factor_uploaded_by']}")
print(f"Valid: {factor['factor_start_date']} to {factor['factor_end_date']}")

Display in UI

Show factor details to users:

const factor = await axios.get(
  `https://api.dcycle.io/api/v1/custom_emission_factors/${factorId}`,
  { headers }
).then(res => res.data);

// Display in UI
document.getElementById('factor-name').textContent = factor.ef_name;
document.getElementById('factor-unit').textContent = factor.unit.name;
document.getElementById('factor-uncertainty').textContent = `${factor.uncertainty_grade}%`;

Common Errors

404 Not Found

Cause: Custom emission factor not found

{
  "detail": "Custom emission factor not found",
  "code": "NOT_FOUND"
}

Solution: Verify the factor ID exists using the list endpoint.

Related Endpoints

Update Factor

Modify factor values

Delete Factor

Remove factor

List Factors

View all factors in group

Overview

Learn about custom factors