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

# Search

## Search for datasets in the database

> This endpoint allows searching for datasets using various filters and query parameters. You find a full list of potential facets in the response of your query.

```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":{"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"},"SearchResponse":{"properties":{"facets":{"$ref":"#/components/schemas/Filters"},"total":{"type":"integer","title":"Total"},"offset":{"type":"integer","title":"Offset"},"limit":{"type":"integer","title":"Limit"},"version":{"type":"string","title":"Version"},"system_model":{"type":"string","title":"System Model"},"results":{"title":"Results","items":{"$ref":"#/components/schemas/ActivityResult"},"type":"array"}},"type":"object","required":["total","offset","limit","version","system_model"],"title":"SearchResponse"},"Filters":{"properties":{"sectors":{"items":{"$ref":"#/components/schemas/FilterData"},"type":"array","title":"Sectors"},"geographies":{"items":{"$ref":"#/components/schemas/GeographyFilterData"},"type":"array","title":"Geographies"},"isic_sections":{"items":{"$ref":"#/components/schemas/FilterData"},"type":"array","title":"Isic Sections"},"isic_classes":{"items":{"$ref":"#/components/schemas/FilterData"},"type":"array","title":"Isic Classes"},"activity_types":{"items":{"$ref":"#/components/schemas/FilterData"},"type":"array","title":"Activity Types"},"geography_hierarchy":{"$ref":"#/components/schemas/GeographyHierarchyRoot"}},"type":"object","required":["sectors","geographies","isic_sections","isic_classes","activity_types"],"title":"Filters"},"FilterData":{"properties":{"name":{"type":"string","title":"Name"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["name","count"],"title":"FilterData"},"GeographyFilterData":{"properties":{"name":{"type":"string","title":"Name"},"count":{"type":"integer","title":"Count"},"short_name":{"title":"Short Name","type":"string"}},"type":"object","required":["name","count"],"title":"GeographyFilterData"},"GeographyHierarchyRoot":{"additionalProperties":{"$ref":"#/components/schemas/GeographyHierarchy"},"type":"object","title":"GeographyHierarchyRoot"},"GeographyHierarchy":{"properties":{"count":{"type":"integer","title":"Count"},"short_name":{"type":"string","title":"Short Name"},"children":{"$ref":"#/components/schemas/GeographyHierarchyRoot"}},"type":"object","required":["count","short_name","children"],"title":"GeographyHierarchy"},"ActivityResult":{"properties":{"name":{"type":"string","title":"Name"},"activity_type":{"$ref":"#/components/schemas/ActivityType","description":"Type of activity, e.g. `TRANSFORMING_ACTIVITY` or `MARKET_ACTIVITY`."},"time_period":{"title":"Time Period","type":"string"},"sectors":{"title":"Sectors","description":"Industrial Sector i.e. Electricity","default":[],"items":{"type":"string"},"type":"array"},"time_period_comment":{"title":"Time Period Comment","description":"Time period comment","default":"","type":"string"},"isic_section":{"type":"string","title":"Isic Section","description":"Standard Classification of all Economic activities, level 1 section"},"isic_class":{"type":"string","title":"Isic Class","description":"Standard Classification of all Economic activities, level 4 class"},"products":{"items":{"$ref":"#/components/schemas/ProductResult"},"type":"array","title":"Products"},"total_products":{"type":"integer","title":"Total Products"}},"type":"object","required":["name","activity_type","time_period","isic_section","isic_class","products","total_products"],"title":"ActivityResult"},"ProductResult":{"properties":{"name":{"title":"Name","type":"string"},"unit":{"title":"Unit","type":"string"},"datasets":{"items":{"$ref":"#/components/schemas/DatasetResult"},"type":"array","title":"Datasets"},"total_datasets":{"type":"integer","title":"Total Datasets"}},"type":"object","required":["datasets","total_datasets"],"title":"ProductResult"},"DatasetResult":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"string","format":"uuid"}],"title":"Id"},"geography":{"type":"string","title":"Geography"},"impact_score":{"title":"Impact Score","type":"number"},"impact_unit":{"title":"Impact Unit","type":"string"},"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"},"technology_comment":{"title":"Technology Comment","description":"Technology comment","default":"","type":"string"},"activity_spold_uuid":{"title":"Activity Spold Uuid","type":"string"},"product_spold_uuid":{"title":"Product Spold Uuid","type":"string"},"geography_spold_uuid":{"title":"Geography Spold Uuid","type":"string"},"ecoquery_url":{"title":"Ecoquery Url","readOnly":true,"type":"string"},"ecoquery_history_url":{"title":"Ecoquery History Url","readOnly":true,"type":"string"}},"type":"object","required":["id","geography","ecoquery_url","ecoquery_history_url"],"title":"DatasetResult"},"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":{"get":{"tags":["api"],"summary":"Search for datasets in the database","description":"This endpoint allows searching for datasets using various filters and query parameters. You find a full list of potential facets in the response of your query.","operationId":"search_datasets_beta_v3_api1_datasets_get","parameters":[{"name":"query","in":"query","required":false,"schema":{"description":"Free-text search query. ","title":"Query","type":"string","maxLength":255},"description":"Free-text search query. "},{"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":"sector","in":"query","required":false,"schema":{"description":"Industrial Sector i.e. Electricity","title":"Sector","type":"string"},"description":"Industrial Sector i.e. Electricity"},{"name":"geography","in":"query","required":false,"schema":{"description":"Geography of production for a product/activity","title":"Geography","type":"string"},"description":"Geography of production for a product/activity"},{"name":"isic_section","in":"query","required":false,"schema":{"description":"Standard Classification of all Economic activities, level 1 section","title":"Isic Section","type":"string"},"description":"Standard Classification of all Economic activities, level 1 section"},{"name":"isic_class","in":"query","required":false,"schema":{"description":"Standard Classification of all Economic activities, level 4 class","title":"Isic Class","type":"string"},"description":"Standard Classification of all Economic activities, level 4 class"},{"name":"activity_type","in":"query","required":false,"schema":{"description":"Type of activity, e.g. `TRANSFORMING_ACTIVITY` or `MARKET_ACTIVITY`.","title":"Activity Type","$ref":"#/components/schemas/ActivityType"},"description":"Type of activity, e.g. `TRANSFORMING_ACTIVITY` or `MARKET_ACTIVITY`."},{"name":"activity_spold_uuid","in":"query","required":false,"schema":{"description":"Filter results by activity spold UUID","title":"Activity Spold Uuid","type":"string","format":"uuid"},"description":"Filter results by activity spold UUID"},{"name":"product_spold_uuid","in":"query","required":false,"schema":{"description":"Filter results by product spold UUID","title":"Product Spold Uuid","type":"string","format":"uuid"},"description":"Filter results by product spold UUID"},{"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 search response with matching datasets","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"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":{}}}}}}}}
```
