curl -X POST "https://api.dcycle.io/v1/emission-factors/custom-databases" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}" \
-H "Content-Type: application/json" \
-d '{
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"countries": [
"ES"
],
"description": "Factors measured at our plants and provided by our waste managers"
}'
import os
import requests
response = requests.post(
"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"],
},
json={
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"countries": [
"ES"
],
"description": "Factors measured at our plants and provided by our waste managers"
},
timeout=30,
)
response.raise_for_status()
print(response.json())
const axios = require('axios');
const response = await axios.post('https://api.dcycle.io/v1/emission-factors/custom-databases', {
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"countries": [
"ES"
],
"description": "Factors measured at our plants and provided by our waste managers"
}, {
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": 0
}
Create Custom Database
Create a custom emission factor database owned by your organization
POST
/
v1
/
emission-factors
/
custom-databases
curl -X POST "https://api.dcycle.io/v1/emission-factors/custom-databases" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}" \
-H "Content-Type: application/json" \
-d '{
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"countries": [
"ES"
],
"description": "Factors measured at our plants and provided by our waste managers"
}'
import os
import requests
response = requests.post(
"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"],
},
json={
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"countries": [
"ES"
],
"description": "Factors measured at our plants and provided by our waste managers"
},
timeout=30,
)
response.raise_for_status()
print(response.json())
const axios = require('axios');
const response = await axios.post('https://api.dcycle.io/v1/emission-factors/custom-databases', {
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"countries": [
"ES"
],
"description": "Factors measured at our plants and provided by our waste managers"
}, {
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": 0
}
← Custom Emission Factors
A database groups your organization’s custom factors. Create one per origin of factors (your own measurements, a supplier, a study…).
Beta. Part of the custom emission factors API, currently in beta. The contract may still change before general
availability.
curl -X POST "https://api.dcycle.io/v1/emission-factors/custom-databases" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}" \
-H "Content-Type: application/json" \
-d '{
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"countries": [
"ES"
],
"description": "Factors measured at our plants and provided by our waste managers"
}'
import os
import requests
response = requests.post(
"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"],
},
json={
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"countries": [
"ES"
],
"description": "Factors measured at our plants and provided by our waste managers"
},
timeout=30,
)
response.raise_for_status()
print(response.json())
const axios = require('axios');
const response = await axios.post('https://api.dcycle.io/v1/emission-factors/custom-databases', {
"name": "acme-measured-factors",
"display_name": "Acme measured factors",
"countries": [
"ES"
],
"description": "Factors measured at our plants and provided by our waste managers"
}, {
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": 0
}
Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51fastring
required
Must be
application/jsonBody Parameters
string
required
Technical name, 1 to 255 characters. It must be unique across all of Dcycle (public databases included), so
prefix it with your company, e.g.
acme-measured-factors.Example: "acme-measured-factors"string
required
Name shown in the platform, 1 to 255 characters.Example:
"Acme measured factors"string | null
Long name. Defaults to
display_name.string | null
Free text: where the factors come from.
string | null
Reference URL, up to 2,048 characters.
array[string] | null
ISO 3166-1 alpha-2 codes the factors apply to.Example:
["ES"]string
default:"all_descendants"
Who in your group can use the database.Available values:
all_descendants (every subsidiary), private (only your organization), selected (the
subsidiaries you share it with explicitly).Response
The created database (201 Created):
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.
409 CUSTOM_DATABASE_NAME_EXISTS
A database (yours, another organization’s or a public one) already has thatname. Choose another.
422 Validation Error
A missing or too long field.Related Endpoints
Create Version
Next step: a version of the database
List Databases
Databases visible to your organization
Was this page helpful?