# searchSupplements

**Identifier:** `dsld_searchSupplements`

**Provider:** [DSLD](https://kirha.com/providers/dsld.md)

Search for dietary supplement labels with advanced filtering. Use getLabelDetails with returned IDs for full ingredient and nutrition data.

## Run it with the CLI

```bash
kirha tools run dsld_searchSupplements \
  --input '{
    "query": "<query>"
  }'
```

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

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": {
    "brand": {
      "type": "string"
    },
    "claimType": {
      "enum": [
        "nutrient",
        "structure_function",
        "approved_health",
        "qualified_health",
        "all_other",
        "no_claims"
      ],
      "type": "string"
    },
    "dateEnd": {
      "description": "YYYY",
      "type": "string"
    },
    "dateStart": {
      "description": "YYYY",
      "type": "string"
    },
    "ingredientCategory": {
      "enum": [
        "amino_acid",
        "animal_part_or_source",
        "blend",
        "botanical",
        "sugars",
        "complex_carbohydrate",
        "enzyme",
        "fat",
        "fatty_acid",
        "fiber",
        "hormone",
        "chemical",
        "bacteria",
        "protein",
        "vitamin",
        "mineral",
        "other",
        "tbd"
      ],
      "type": "string"
    },
    "ingredientName": {
      "description": "e.g., Vitamin D, Iron",
      "type": "string"
    },
    "limit": {
      "default": 10,
      "maximum": 50,
      "minimum": 1,
      "type": "number"
    },
    "marketStatus": {
      "default": "on_market",
      "enum": [
        "on_market",
        "off_market",
        "all"
      ],
      "type": "string"
    },
    "offset": {
      "default": 0,
      "minimum": 0,
      "type": "number"
    },
    "productType": {
      "enum": [
        "amino_acid",
        "animal_extract",
        "botanical",
        "combination",
        "enzyme",
        "fatty_acid",
        "fish_oil",
        "multivitamin_mineral",
        "multivitamin",
        "probiotic",
        "other"
      ],
      "type": "string"
    },
    "query": {
      "description": "Search term, use * for unfiltered search",
      "type": "string"
    },
    "sortBy": {
      "default": "relevance",
      "enum": [
        "relevance",
        "entry_date",
        "name"
      ],
      "type": "string"
    },
    "sortOrder": {
      "default": "desc",
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string"
    },
    "supplementForm": {
      "enum": [
        "bar",
        "capsule",
        "softgel",
        "tablet",
        "gummy",
        "liquid",
        "lozenge",
        "powder",
        "other",
        "unknown"
      ],
      "type": "string"
    },
    "targetGroup": {
      "enum": [
        "adults_and_children_4plus",
        "infants_children_under_4",
        "pregnant_lactating",
        "adult_50plus"
      ],
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "ids": {
      "description": "DSLD label IDs for use with getLabelDetails",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "percentOfDatabase": {
      "type": "number"
    },
    "products": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "brandName": {
            "type": "string"
          },
          "entryDate": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "ingredients": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "name": {
            "type": "string"
          },
          "onMarket": {
            "type": "boolean"
          },
          "productType": {
            "type": "string"
          },
          "supplementForm": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "brandName",
          "entryDate",
          "onMarket",
          "productType",
          "supplementForm",
          "ingredients"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "totalCount": {
      "type": "number"
    }
  },
  "required": [
    "context",
    "totalCount",
    "percentOfDatabase",
    "products",
    "ids"
  ],
  "type": "object"
}
```

## Related tools

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

- [`getLabelDetails`](https://kirha.com/providers/dsld/getLabelDetails.md)

-----

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