> For the complete documentation index, see [llms.txt](https://docs.api.ecoinvent.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.api.ecoinvent.org/api-reference/batch.md).

# Batch

## Retrieve multiple datasets in a batch, optionally with scores

> This endpoint allows retrieving multiple datasets in a batch using their IDs. Optionally, it can also return impact scores for the specified indicators.\
> \
> \`POST\` is used despite this being a read operation because dataset IDs are submitted in the request body: batches can contain up to 1000 IDs, which would exceed practical URL length limits if passed as query parameters.

```json
{"openapi":"3.1.0","info":{"title":"ecoQuery User API","version":"0.0.1"},"servers":[{"url":"https://api.ecoinvent.org"}],"security":[{"OAuth2ClientCredentials":[]}],"components":{"securitySchemes":{"OAuth2ClientCredentials":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://sso.ecoinvent.org/realms/ecoinvent/protocol/openid-connect/token"}}}},"schemas":{"DatasetBatchRequest":{"properties":{"dataset_ids":{"items":{"type":"integer"},"type":"array","maxItems":1000,"minItems":1,"title":"Dataset Ids","description":"List of dataset IDs to retrieve (up to 1000 datasets)"},"indicator_ids":{"items":{"type":"integer"},"type":"array","maxItems":100,"title":"Indicator Ids","description":"List of indicators IDs to retrieve","default":[]}},"type":"object","required":["dataset_ids"],"title":"DatasetBatchRequest"},"BatchResponse":{"properties":{"version":{"type":"string","title":"Version"},"system_model":{"type":"string","title":"System Model"},"total":{"type":"integer","title":"Total","default":0},"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"datasets":{"items":{"$ref":"#/components/schemas/Dataset"},"type":"array","title":"Datasets"}},"type":"object","required":["version","system_model","offset","limit"],"title":"BatchResponse"},"Dataset":{"properties":{"id":{"type":"integer","title":"Id","description":"Id of the dataset"},"activity":{"type":"string","title":"Activity"},"product":{"title":"Product","type":"string"},"geography":{"type":"string","title":"Geography"},"description":{"type":"string","title":"Description","default":""},"included_activity_starts":{"title":"Included Activity Starts","description":"Included activity starts","default":"","type":"string"},"included_activity_ends":{"title":"Included Activity Ends","description":"Included activity ends","default":"","type":"string"},"time_period_comment":{"title":"Time Period Comment","description":"Time period comment","default":"","type":"string"},"technology_comment":{"title":"Technology Comment","description":"Technology comment","default":"","type":"string"},"unit":{"title":"Unit","type":"string"},"time_period":{"title":"Time Period","type":"string"},"activity_type":{"$ref":"#/components/schemas/ActivityType","description":"Type of activity, e.g. `TRANSFORMING_ACTIVITY` or `MARKET_ACTIVITY`."},"isic_section":{"title":"Isic Section","description":"Standard Classification of all Economic activities, level 1 section","type":"string"},"isic_class":{"title":"Isic Class","description":"Standard Classification of all Economic activities, level 4 class","type":"string"},"sectors":{"items":{"type":"string"},"type":"array","title":"Sectors","description":"Industrial Sector i.e. Electricity"},"impact_scores":{"title":"Impact Scores","items":{"$ref":"#/components/schemas/ImpactScore"},"type":"array"},"activity_spold_uuid":{"type":"string","title":"Activity Spold Uuid","description":"UUID of the associated activity in spold"},"product_spold_uuid":{"title":"Product Spold Uuid","description":"UUID of the associated product in spold","type":"string"},"geography_spold_uuid":{"type":"string","title":"Geography Spold Uuid","description":"UUID of the associated geography in spold"},"ecoquery_url":{"title":"Ecoquery Url","readOnly":true,"type":"string"},"ecoquery_history_url":{"title":"Ecoquery History Url","readOnly":true,"type":"string"}},"type":"object","required":["id","activity","geography","time_period","activity_type","sectors","activity_spold_uuid","product_spold_uuid","geography_spold_uuid","ecoquery_url","ecoquery_history_url"],"title":"Dataset"},"ActivityType":{"type":"string","enum":["TRANSFORMING_ACTIVITY","MARKET_ACTIVITY","IO_ACTIVITY","RESIDUAL_ACTIVITY","PRODUCTION_MIX","IMPORT_ACTIVITY","SUPPLY_MIX","EXPORT_ACTIVITY","RE_EXPORT_ACTIVITY","CORRECTION_ACTIVITY","MARKET_GROUP"],"title":"ActivityType"},"ImpactScore":{"properties":{"id":{"type":"integer","title":"Id","description":"Id of the indicator"},"score":{"type":"number","title":"Score","description":"Numerical score value"},"unit":{"type":"string","title":"Unit","description":"Unit of measurement for the score"},"method":{"type":"string","title":"Method","description":"LCIA method name"},"category":{"type":"string","title":"Category","description":"Impact category"},"indicator":{"type":"string","title":"Indicator","description":"Impact indicator"}},"type":"object","required":["id","score","unit","method","category","indicator"],"title":"ImpactScore"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v3/api1/datasets/batch":{"post":{"tags":["api"],"summary":"Retrieve multiple datasets in a batch, optionally with scores","description":"This endpoint allows retrieving multiple datasets in a batch using their IDs. Optionally, it can also return impact scores for the specified indicators.\n\n`POST` is used despite this being a read operation because dataset IDs are submitted in the request body: batches can contain up to 1000 IDs, which would exceed practical URL length limits if passed as query parameters.","operationId":"get_batch_datasets_v3_v3_api1_datasets_batch_post","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination start index","default":0,"title":"Offset"},"description":"Pagination start index"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"description":"Number of results to return","default":10,"title":"Limit"},"description":"Number of results to return"},{"name":"version","in":"query","required":false,"schema":{"type":"string","description":"Version name or 'latest'","default":"latest","title":"Version"},"description":"Version name or 'latest'"},{"name":"system_model","in":"query","required":false,"schema":{"type":"string","description":"System model name or 'cutoff'","default":"cutoff","title":"System Model"},"description":"System model name or 'cutoff'"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetBatchRequest"}}}},"responses":{"200":{"description":"Successful search response with matching datasets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{}}},"403":{"description":"Forbidden","content":{"application/json":{}}},"404":{"description":"Requested resource not found","content":{"application/json":{}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{}}}}}}}}
```
