> 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/exchanges.md).

# Exchanges

## Retrieve the intermediate exchanges of a dataset

> This endpoint returns the technosphere flows of a dataset, with their suppliers, classifications and properties.

```json
{"openapi":"3.1.0","info":{"title":"ecoQuery User API","version":"0.0.1"},"servers":[{"url":"https://api.ecoinvent.org"}],"security":[{"OAuth2ClientCredentials":[]},{"OAuth2PasswordBearer":[]}],"components":{"securitySchemes":{"OAuth2ClientCredentials":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://sso.ecoinvent.org/realms/ecoinvent/protocol/openid-connect/token"}}},"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"https://sso.ecoinvent.org/realms/ecoinvent/protocol/openid-connect/token"}}}},"schemas":{"IntermediateExchangeResponse":{"properties":{"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"total":{"type":"integer","title":"Total","description":"Total number of results"},"version":{"type":"string","title":"Version"},"system_model":{"type":"string","title":"System Model"},"dataset_id":{"type":"integer","title":"Dataset Id"},"results":{"items":{"$ref":"#/components/schemas/IntermediateExchangeEntry"},"type":"array","title":"Results"}},"type":"object","required":["offset","limit","total","version","system_model","dataset_id"],"title":"IntermediateExchangeResponse","description":"A page of the intermediate exchanges of a dataset."},"IntermediateExchangeEntry":{"properties":{"intermediate_exchange":{"$ref":"#/components/schemas/NamedReference"},"unit":{"$ref":"#/components/schemas/NamedReference"},"group":{"type":"string","title":"Group","description":"Exchange group, e.g. 'REFERENCE_PRODUCT'"},"amount":{"type":"number","title":"Amount"},"comment":{"title":"Comment","type":"string"},"cas_number":{"title":"Cas Number","type":"string"},"supplier":{"$ref":"#/components/schemas/ExchangeSupplier"},"production_volume":{"$ref":"#/components/schemas/ProductionVolume"},"uncertainty":{"$ref":"#/components/schemas/ExchangeUncertainty"},"classifications":{"items":{"$ref":"#/components/schemas/ExchangeClassification"},"type":"array","title":"Classifications"},"properties":{"items":{"$ref":"#/components/schemas/ExchangeProperty"},"type":"array","title":"Properties"}},"type":"object","required":["intermediate_exchange","unit","group","amount"],"title":"IntermediateExchangeEntry","description":"A single intermediate exchange of a dataset."},"NamedReference":{"properties":{"spold_uuid":{"title":"Spold Uuid","description":"UUID of the entity in spold, when available","type":"string","format":"uuid"},"name":{"type":"string","title":"Name","description":"Name of the entity"}},"type":"object","required":["name"],"title":"NamedReference","description":"A named entity of an exchange."},"ExchangeSupplier":{"properties":{"dataset_id":{"type":"integer","title":"Dataset Id"},"name":{"type":"string","title":"Name"},"geography":{"type":"string","title":"Geography"}},"type":"object","required":["dataset_id","name","geography"],"title":"ExchangeSupplier","description":"The dataset a technosphere input is linked to."},"ProductionVolume":{"properties":{"amount":{"title":"Amount","type":"number"},"comment":{"title":"Comment","type":"string"}},"type":"object","title":"ProductionVolume","description":"The annual production volume of an exchange."},"ExchangeUncertainty":{"properties":{"type":{"type":"string","title":"Type","description":"Distribution name, e.g. 'lognormal'"},"pedigree_matrix":{"title":"Pedigree Matrix","description":"The five pedigree scores, in spold order","items":{"type":"integer"},"type":"array"},"comment":{"title":"Comment","type":"string"},"value":{"additionalProperties":{"type":"number"},"type":"object","title":"Value","description":"Parameters of the distribution"}},"type":"object","required":["type"],"title":"ExchangeUncertainty","description":"The uncertainty of an exchange or of one of its properties."},"ExchangeClassification":{"properties":{"system":{"type":"string","title":"System","description":"Classification system, e.g. 'CPC'"},"value":{"type":"string","title":"Value"}},"type":"object","required":["system","value"],"title":"ExchangeClassification","description":"A classification of the exchanged product."},"ExchangeProperty":{"properties":{"property":{"$ref":"#/components/schemas/NamedReference"},"unit":{"$ref":"#/components/schemas/NamedReference"},"amount":{"type":"number","title":"Amount"},"comment":{"title":"Comment","type":"string"},"uncertainty":{"$ref":"#/components/schemas/ExchangeUncertainty"}},"type":"object","required":["property","amount"],"title":"ExchangeProperty","description":"A property of an exchange."},"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/{id}/exchanges/intermediate":{"get":{"tags":["api"],"summary":"Retrieve the intermediate exchanges of a dataset","description":"This endpoint returns the technosphere flows of a dataset, with their suppliers, classifications and properties.","operationId":"get_dataset_intermediate_exchanges_v3_v3_api1_datasets__id__exchanges_intermediate_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","description":"Dataset ID to retrieve","title":"Id"},"description":"Dataset ID to retrieve"},{"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,"minimum":1,"description":"Number of results to return","default":20,"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'"}],"responses":{"200":{"description":"Successful response with the requested intermediate exchanges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntermediateExchangeResponse"}}}},"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":{}}}}}}}}
```

## Retrieve the elementary exchanges of a dataset

> This endpoint returns the environmental flows of a dataset, with their compartments, direction and properties.

```json
{"openapi":"3.1.0","info":{"title":"ecoQuery User API","version":"0.0.1"},"servers":[{"url":"https://api.ecoinvent.org"}],"security":[{"OAuth2ClientCredentials":[]},{"OAuth2PasswordBearer":[]}],"components":{"securitySchemes":{"OAuth2ClientCredentials":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://sso.ecoinvent.org/realms/ecoinvent/protocol/openid-connect/token"}}},"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"https://sso.ecoinvent.org/realms/ecoinvent/protocol/openid-connect/token"}}}},"schemas":{"ElementaryExchangeResponse":{"properties":{"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"total":{"type":"integer","title":"Total","description":"Total number of results"},"version":{"type":"string","title":"Version"},"system_model":{"type":"string","title":"System Model"},"dataset_id":{"type":"integer","title":"Dataset Id"},"results":{"items":{"$ref":"#/components/schemas/ElementaryExchangeEntry"},"type":"array","title":"Results"}},"type":"object","required":["offset","limit","total","version","system_model","dataset_id"],"title":"ElementaryExchangeResponse","description":"A page of the elementary exchanges of a dataset."},"ElementaryExchangeEntry":{"properties":{"elementary_exchange":{"$ref":"#/components/schemas/NamedReference"},"compartment":{"$ref":"#/components/schemas/NamedReference"},"sub_compartment":{"$ref":"#/components/schemas/NamedReference"},"unit":{"$ref":"#/components/schemas/NamedReference"},"amount":{"type":"number","title":"Amount"},"direction":{"type":"string","title":"Direction","description":"Exchange direction, e.g. 'FROM_ENVIRONMENT'"},"comment":{"title":"Comment","type":"string"},"cas_number":{"title":"Cas Number","type":"string"},"uncertainty":{"$ref":"#/components/schemas/ExchangeUncertainty"},"properties":{"items":{"$ref":"#/components/schemas/ExchangeProperty"},"type":"array","title":"Properties"}},"type":"object","required":["elementary_exchange","compartment","sub_compartment","unit","amount","direction"],"title":"ElementaryExchangeEntry","description":"A single elementary exchange of a dataset."},"NamedReference":{"properties":{"spold_uuid":{"title":"Spold Uuid","description":"UUID of the entity in spold, when available","type":"string","format":"uuid"},"name":{"type":"string","title":"Name","description":"Name of the entity"}},"type":"object","required":["name"],"title":"NamedReference","description":"A named entity of an exchange."},"ExchangeUncertainty":{"properties":{"type":{"type":"string","title":"Type","description":"Distribution name, e.g. 'lognormal'"},"pedigree_matrix":{"title":"Pedigree Matrix","description":"The five pedigree scores, in spold order","items":{"type":"integer"},"type":"array"},"comment":{"title":"Comment","type":"string"},"value":{"additionalProperties":{"type":"number"},"type":"object","title":"Value","description":"Parameters of the distribution"}},"type":"object","required":["type"],"title":"ExchangeUncertainty","description":"The uncertainty of an exchange or of one of its properties."},"ExchangeProperty":{"properties":{"property":{"$ref":"#/components/schemas/NamedReference"},"unit":{"$ref":"#/components/schemas/NamedReference"},"amount":{"type":"number","title":"Amount"},"comment":{"title":"Comment","type":"string"},"uncertainty":{"$ref":"#/components/schemas/ExchangeUncertainty"}},"type":"object","required":["property","amount"],"title":"ExchangeProperty","description":"A property of an exchange."},"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/{id}/exchanges/elementary":{"get":{"tags":["api"],"summary":"Retrieve the elementary exchanges of a dataset","description":"This endpoint returns the environmental flows of a dataset, with their compartments, direction and properties.","operationId":"get_dataset_elementary_exchanges_v3_v3_api1_datasets__id__exchanges_elementary_get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","description":"Dataset ID to retrieve","title":"Id"},"description":"Dataset ID to retrieve"},{"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,"minimum":1,"description":"Number of results to return","default":20,"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'"}],"responses":{"200":{"description":"Successful response with the requested elementary exchanges","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElementaryExchangeResponse"}}}},"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":{}}}}}}}}
```
