Get LCA Portfolio

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

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

import requests

url = "https://api.dcycle.io/v1/lca/portfolio/{lca_id}"

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

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

print(response.text)

{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "description": {},
  "impact_categories": {},
  "final_product_id": {},
  "unit_id": "<string>",
  "value": 123,
  "start_date": "<string>",
  "end_date": "<string>",
  "status": "<string>",
  "created_at": {},
  "updated_at": {}
}

GET

lca

portfolio

{lca_id}

Get LCA Portfolio

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

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

import requests

url = "https://api.dcycle.io/v1/lca/portfolio/{lca_id}"

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

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

print(response.text)

{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "description": {},
  "impact_categories": {},
  "final_product_id": {},
  "unit_id": "<string>",
  "value": 123,
  "start_date": "<string>",
  "end_date": "<string>",
  "status": "<string>",
  "created_at": {},
  "updated_at": {}
}

Get LCA Portfolio

Returns the details of a specific LCA portfolio, including its name, date range, functional unit, impact categories, and current status.

Request

Headers

string

required

Your API key for authenticationExample: sk_live_1234567890abcdef

string

required

Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

string

required

UUID of the LCA portfolioExample: 550e8400-e29b-41d4-a716-446655440000

Response

string

UUID of the LCA portfolio

string

UUID of the organization that owns this portfolio

string

Name of the LCA portfolio

string | null

Optional description of the portfolio

array[string]

List of impact category identifiers included in this assessment (e.g. "gwp", "ap", "ep")

string | null

UUID of the primary output product (co-product), if set

string

Functional unit identifier (e.g. "kg", "unit")

number

Functional unit quantity

date

Start date of the assessment period (YYYY-MM-DD)

date

End date of the assessment period (YYYY-MM-DD)

string

Current status of the portfolio

datetime

When the portfolio was created (ISO 8601)

datetime | null

When the portfolio was last updated (ISO 8601)

Example

curl -X GET "https://api.dcycle.io/v1/lca/portfolio/${LCA_ID}" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

import requests
import os

response = requests.get(
    f"https://api.dcycle.io/v1/lca/portfolio/{os.getenv('LCA_ID')}",
    headers={
        "x-api-key": os.getenv("DCYCLE_API_KEY"),
        "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
    },
)

portfolio = response.json()
print(f"Portfolio: {portfolio['name']}")
print(f"Period: {portfolio['start_date']} to {portfolio['end_date']}")
print(f"Impact categories: {', '.join(portfolio['impact_categories'])}")
print(f"Functional unit: {portfolio['value']} {portfolio['unit_id']}")

const axios = require('axios');

const lcaId = process.env.LCA_ID;

axios.get(`https://api.dcycle.io/v1/lca/portfolio/${lcaId}`, {
  headers: {
    'x-api-key': process.env.DCYCLE_API_KEY,
    'x-organization-id': process.env.DCYCLE_ORG_ID,
  },
})
.then(({ data }) => {
  console.log(`Portfolio: ${data.name}`);
  console.log(`Period: ${data.start_date} to ${data.end_date}`);
  console.log(`Impact categories: ${data.impact_categories.join(', ')}`);
});

Successful Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
  "name": "Product A - Environmental Impact 2024",
  "description": "Full cradle-to-gate LCA for Product A",
  "impact_categories": ["gwp", "ap", "ep", "pocp", "adp"],
  "final_product_id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "unit_id": "kg",
  "value": 1.0,
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "status": "active",
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-06-20T14:30:00Z"
}

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The authenticated user is not a member of the organization

{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

404 Not Found

Cause: LCA portfolio not found or doesn’t belong to your organization

{"detail": "LCA Portfolio not found"}

List LCA Portfolios

Browse all LCA portfolios

LCA Dashboard

Get environmental impact results

​Get LCA Portfolio

​Request

​Headers

​Path Parameters

​Response

​Example

​Successful Response

​Common Errors

​401 Unauthorized

​403 Forbidden

​404 Not Found

​Related Endpoints

List LCA Portfolios

LCA Dashboard

Get LCA Portfolio

Request

Headers

Path Parameters

Response

Example

Successful Response

Common Errors

401 Unauthorized

403 Forbidden

404 Not Found

Related Endpoints