curl -X GET "https://api.dcycle.io/v1/emission-factors/custom-databases" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
import os
import requests
response = requests.get(
"https://api.dcycle.io/v1/emission-factors/custom-databases",
headers={
"x-api-key": os.environ["DCYCLE_API_KEY"],
"x-organization-id": os.environ["DCYCLE_ORG_ID"],
},
timeout=30,
)
response.raise_for_status()
print(response.json())
const axios = require('axios');
const response = await axios.get('https://api.dcycle.io/v1/emission-factors/custom-databases', {
headers: {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID,
},
});
console.log(response.status, response.data);
[
{
"id": "5f1c2e7a-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"full_name": "Acme measured factors",
"description": "Factors measured at our plants and provided by our waste managers",
"website": null,
"countries": [
"ES"
],
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"owner_organization_name": "Acme Industrial S.L.",
"child_access": "all_descendants",
"image_url": null,
"version_count": 1
}
]
List Custom Databases
Custom emission factor databases visible to your organization
GET
/
v1
/
emission-factors
/
custom-databases
curl -X GET "https://api.dcycle.io/v1/emission-factors/custom-databases" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
import os
import requests
response = requests.get(
"https://api.dcycle.io/v1/emission-factors/custom-databases",
headers={
"x-api-key": os.environ["DCYCLE_API_KEY"],
"x-organization-id": os.environ["DCYCLE_ORG_ID"],
},
timeout=30,
)
response.raise_for_status()
print(response.json())
const axios = require('axios');
const response = await axios.get('https://api.dcycle.io/v1/emission-factors/custom-databases', {
headers: {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID,
},
});
console.log(response.status, response.data);
[
{
"id": "5f1c2e7a-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"full_name": "Acme measured factors",
"description": "Factors measured at our plants and provided by our waste managers",
"website": null,
"countries": [
"ES"
],
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"owner_organization_name": "Acme Industrial S.L.",
"child_access": "all_descendants",
"image_url": null,
"version_count": 1
}
]
← Custom Emission Factors
The custom databases your organization can use: the ones it owns and the ones its group shares with it.
This endpoint takes no parameters.
Beta. Part of the custom emission factors API, currently in beta. The contract may still change before general
availability.
curl -X GET "https://api.dcycle.io/v1/emission-factors/custom-databases" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
import os
import requests
response = requests.get(
"https://api.dcycle.io/v1/emission-factors/custom-databases",
headers={
"x-api-key": os.environ["DCYCLE_API_KEY"],
"x-organization-id": os.environ["DCYCLE_ORG_ID"],
},
timeout=30,
)
response.raise_for_status()
print(response.json())
const axios = require('axios');
const response = await axios.get('https://api.dcycle.io/v1/emission-factors/custom-databases', {
headers: {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID,
},
});
console.log(response.status, response.data);
[
{
"id": "5f1c2e7a-3b4d-4e8f-9a01-2c3d4e5f6a7b",
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"full_name": "Acme measured factors",
"description": "Factors measured at our plants and provided by our waste managers",
"website": null,
"countries": [
"ES"
],
"organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
"owner_organization_name": "Acme Industrial S.L.",
"child_access": "all_descendants",
"image_url": null,
"version_count": 1
}
]
Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faResponse
An array of databases:uuid
Database id.
string
Unique technical name.
string
Name shown in the platform.
string
Long name; defaults to
display_name.string | null
Free text.
string | null
Reference URL.
array[string] | null
ISO 3166-1 alpha-2 codes the factors apply to.
uuid
Owning organization.
string | null
Owning organization’s name.
string
Who in the group can use it. Available values:
private, all_descendants, selected.string | null
Logo URL.
integer
Number of versions.
Common Errors
401 Unauthorized
Missing or invalid API key.403 Forbidden
LOGGED_USER_NOT_MEMBER: the API key’s user is not a member of the organization in x-organization-id.
Related Endpoints
Create Database
A new database owned by your organization
List Versions
Versions of a database
Was this page helpful?