# searchSubstances

**Identifier:** `eudravigilance_searchSubstances`

**Provider:** [EudraVigilance](https://kirha.com/providers/eudravigilance.md)

Search EudraVigilance substances by name and get their Substance High Level Code. Use the returned substanceHighLevelCodes with getSubstanceAdverseReactionAggregates to fetch suspected adverse reaction breakdowns for a substance.

## Run it with the CLI

```bash
kirha tools run eudravigilance_searchSubstances \
  --input '{}'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "eudravigilance_searchSubstances",
  "input": {}
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "default": 10,
      "maximum": 25,
      "minimum": 1,
      "type": "number"
    },
    "query": {
      "default": "",
      "description": "Substance name to search for, e.g. \"abacavir\" or \"ibuprofen\". Pass only the substance name, not a descriptive phrase or question (e.g. not \"HIV medication\").",
      "type": "string"
    }
  },
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "substanceHighLevelCodes": {
      "description": "Substance High Level Codes for composition with getSubstanceAdverseReactionAggregates",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "substances": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "substanceHighLevelCode": {
            "type": "string"
          },
          "substanceName": {
            "type": "string"
          }
        },
        "required": [
          "substanceName",
          "substanceHighLevelCode"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "context",
    "substances",
    "substanceHighLevelCodes"
  ],
  "type": "object"
}
```

## Related tools

Other EudraVigilance tools that this tool refers to, or that refer to it.

- [`getSubstanceAdverseReactionAggregates`](https://kirha.com/providers/eudravigilance/getSubstanceAdverseReactionAggregates.md)
- [`getSubstanceReactionDetail`](https://kirha.com/providers/eudravigilance/getSubstanceReactionDetail.md)
- [`getSubstanceCaseAccrual`](https://kirha.com/providers/eudravigilance/getSubstanceCaseAccrual.md)
- [`getSubstanceReactionDisproportionality`](https://kirha.com/providers/eudravigilance/getSubstanceReactionDisproportionality.md)
- [`searchProducts`](https://kirha.com/providers/eudravigilance/searchProducts.md)
- [`getSubstanceReactionBreakdown`](https://kirha.com/providers/eudravigilance/getSubstanceReactionBreakdown.md)

-----

[All EudraVigilance tools](https://kirha.com/providers/eudravigilance.md) · [< Back to tools list](https://kirha.com/tools.md)