The ecoinvent API is currently in beta. You may experience occasional instability, we appreciate your understanding.
Support

Datasets

Retrieve multiple datasets in a batch, optionally with scores

post

This endpoint allows retrieving multiple datasets in a batch using their IDs. Optionally, it can also return impact scores for the specified indicators.

Authorizations
Query parameters
fromintegerOptional

Pagination start index

Default: 0
limitinteger · max: 100Optional

Number of results to return

Default: 10
versionstringOptional

Version name or 'latest'

Default: latest
system_modelstringOptional

System model name or 'cutoff'

Default: cutoff
Header parameters
X-User-IdstringOptional
X-Organization-IdstringOptional
Body
dataset_idsinteger[] · min: 1 · max: 10000Required

List of dataset IDs to retrieve (up to 10000 datasets)

indicator_idsinteger[] · max: 100Optional

List of indicators IDs to retrieve

Default: []
Responses
200
Successful search response with matching datasets
application/json
post
POST /v0/datasets/batch HTTP/1.1
Host: api.ecoinvent.org
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "dataset_ids": [
    1
  ],
  "indicator_ids": [
    1
  ]
}
{
  "total": 1,
  "datasets": [
    {
      "id": 12345,
      "activity": "electricity production",
      "product": "electricity, high voltage",
      "description": "Production of high voltage electricity",
      "geography": "Switzerland (CH)",
      "unit": "kWh",
      "time_period": "2012-2022",
      "activity_type": "ordinary transforming activity",
      "isic_section": "D - Electricity",
      "isic_class": "3510 - Electric power generation",
      "activity_spold_uuid": "ff12345a-1234-5678-9abc-123456789abc",
      "geography_spold_uuid": "dd12345a-1234-5678-9abc-123456789abc",
      "product_spold_uuid": "ee12345a-1234-5678-9abc-123456789abc",
      "sectors": [
        "Electricity"
      ],
      "url": "https://ecoquery.ecoinvent.org/3.00/cutoff/dataset/12345/documentation",
      "url_history": "https://ecoquery.ecoinvent.org/3.00/cutoff/dataset/12345/history",
      "impact_scores": [
        {
          "id": 43,
          "score": 42.5,
          "unit": "kg CO2 eq",
          "method": "IPCC 2021",
          "category": "climate change",
          "indicator": "global warming potential"
        }
      ]
    }
  ]
}

Retrieve a specific dataset by its ID, optionally with scores

get

This endpoint allows retrieving a specific dataset using its ID. Optionally, it can also return impact scores for the specified indicators.

Authorizations
Path parameters
idintegerRequired

Dataset ID to retrieve

Query parameters
indicator_idsinteger[]Optional

List of indicators IDs to retrieve

Default: []
versionstringOptional

Version name or 'latest'

Default: latest
system_modelstringOptional

System model name or 'cutoff'

Default: cutoff
Header parameters
X-User-IdstringOptional
X-Organization-IdstringOptional
Responses
200
Successful response with the requested dataset
application/json
get
GET /v0/datasets/{id} HTTP/1.1
Host: api.ecoinvent.org
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": 12345,
  "activity": "electricity production",
  "product": "electricity, high voltage",
  "description": "Production of high voltage electricity",
  "geography": "Switzerland (CH)",
  "unit": "kWh",
  "time_period": "2012-2022",
  "activity_type": "ordinary transforming activity",
  "isic_section": "D - Electricity",
  "isic_class": "3510 - Electric power generation",
  "activity_spold_uuid": "ff12345a-1234-5678-9abc-123456789abc",
  "geography_spold_uuid": "dd12345a-1234-5678-9abc-123456789abc",
  "product_spold_uuid": "ee12345a-1234-5678-9abc-123456789abc",
  "sectors": [
    "Electricity"
  ],
  "url": "https://ecoquery.ecoinvent.org/3.00/cutoff/dataset/12345/documentation",
  "url_history": "https://ecoquery.ecoinvent.org/3.00/cutoff/dataset/12345/history",
  "impact_scores": [
    {
      "id": 43,
      "score": 42.5,
      "unit": "kg CO2 eq",
      "method": "IPCC 2021",
      "category": "climate change",
      "indicator": "global warming potential"
    }
  ]
}
PreviousIndicators

Last updated

Was this helpful?