Datasets

This endpoint is based on the API limits of your license. Currently, the API does not automatically block requests when limits are exceeded, which may result in overage charges. Please monitor your usage carefully to avoid unexpected costs.

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

OAuth2ClientCredentials

OAuth2clientCredentialsRequired

Token URL:

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-Idany ofOptional

stringOptional

or

nullOptional

X-Organization-Idany ofOptional

stringOptional

or

nullOptional

Body

application/json

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

totalintegerOptionalDefault: 0

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource not found

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/v0/datasets/batch

HTTPcURLJavaScriptPython

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": "Generation of high-voltage electricity supplied to the grid",
      "included_activity_starts": "from cradle",
      "included_activity_ends": "to gate",
      "time_period_comment": "Representative for the period 2012-2022",
      "technology_comment": "Average European technology mix",
      "geography": "Switzerland (CH)",
      "unit": "kWh",
      "time_period": "2012-2022",
      "activity_type": "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"
      ],
      "version": "3.12",
      "system_model": "cutoff",
      "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

OAuth2ClientCredentials

OAuth2clientCredentialsRequired

Token URL:

Path parameters

idintegerRequired

Dataset ID to retrieve

Query parameters

versionstringOptional

Version name or 'latest'

Default: latest

system_modelstringOptional

System model name or 'cutoff'

Default: cutoff

indicator_idsany ofOptional

List of indicator IDs to retrieve. Supports either repeated parameters (?indicator_ids=1&indicator_ids=2) or a single comma-separated value (?indicator_ids=1,2).

string[]Optional

or

nullOptional

Header parameters

X-User-Idany ofOptional

stringOptional

or

nullOptional

X-Organization-Idany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful response with the requested dataset

application/json

idintegerRequired

Id of the dataset

activitystringRequired

productany ofOptional

stringOptional

or

nullOptional

geographystringRequired

descriptionstringOptionalDefault: ""

included_activity_startsany ofOptional

Included activity starts

Default: ""

stringOptional

or

nullOptional

included_activity_endsany ofOptional

Included activity ends

Default: ""

stringOptional

or

nullOptional

time_period_commentany ofOptional

Time period comment

Default: ""

stringOptional

or

nullOptional

technology_commentany ofOptional

Technology comment

Default: ""

stringOptional

or

nullOptional

unitany ofOptional

stringOptional

or

nullOptional

time_periodany ofRequired

stringOptional

or

nullOptional

activity_typestringRequired

Type of activity i.e. market or transforming activity

isic_sectionany ofOptional

Standard Classification of all Economic activities, level 1 section

stringOptional

or

nullOptional

isic_classany ofOptional

Standard Classification of all Economic activities, level 4 class

stringOptional

or

nullOptional

activity_spold_uuidstringRequired

UUID of the associated activity in spold

geography_spold_uuidstringRequired

UUID of the associated geography in spold

product_spold_uuidany ofRequired

UUID of the associated product in spold

stringOptional

or

nullOptional

sectorsstring[]Required

Industrial Sector i.e. Electricity

impact_scoresany ofOptional

or

nullOptional

urlany ofRead-onlyRequired

stringOptional

or

nullOptional

url_historyany ofRead-onlyRequired

stringOptional

or

nullOptional

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource not found

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

/v0/datasets/{id}

HTTPcURLJavaScriptPython

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": "Generation of high-voltage electricity supplied to the grid",
  "included_activity_starts": "from cradle",
  "included_activity_ends": "to gate",
  "time_period_comment": "Representative for the period 2012-2022",
  "technology_comment": "Average European technology mix",
  "geography": "Switzerland (CH)",
  "unit": "kWh",
  "time_period": "2012-2022",
  "activity_type": "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"
  ],
  "version": "3.12",
  "system_model": "cutoff",
  "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"
    }
  ]
}