# getDrugProducts

**Identifier:** `rxnorm_getDrugProducts`

**Provider:** [RxNorm](https://kirha.com/providers/rxnorm.md)

Get all drug products (branded and generic formulations) for a drug name, grouped by term type (SCD, SBD, GPCK, BPCK). Use this to discover formulations, strengths, and brands.

## Run it with the CLI

```bash
kirha tools run rxnorm_getDrugProducts \
  --input '{
    "drugName": "<drugName>"
  }'
```

`--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": "rxnorm_getDrugProducts",
  "input": {
    "drugName": "<drugName>"
  }
}'
```

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": {
    "drugName": {
      "minLength": 1,
      "type": "string"
    },
    "offset": {
      "default": 0,
      "description": "Skip this many products per term type; page by 120 while productCounts is larger",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "drugName"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "productCounts": {
      "additionalProperties": {
        "type": "number"
      },
      "description": "Term type -> total products, ignoring offset and cap",
      "propertyNames": {
        "type": "string"
      },
      "type": "object"
    },
    "products": {
      "description": "At most 120 per term type from offset",
      "items": {
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "rxcui": {
            "type": "string"
          },
          "synonym": {
            "type": "string"
          },
          "tty": {
            "type": "string"
          }
        },
        "required": [
          "rxcui",
          "name",
          "tty"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "rxcuis": {
      "description": "RxCUIs of found products for use with other RxNorm tools",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "context",
    "products",
    "productCounts",
    "rxcuis"
  ],
  "type": "object"
}
```

## Related tools

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

- [`getConceptProperties`](https://kirha.com/providers/rxnorm/getConceptProperties.md)
- [`getRelatedByType`](https://kirha.com/providers/rxnorm/getRelatedByType.md)
- [`getAllRelatedConcepts`](https://kirha.com/providers/rxnorm/getAllRelatedConcepts.md)

-----

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