# searchFaersPotentialSignals

**Identifier:** `openfda_searchFaersPotentialSignals`

**Provider:** [OpenFDA](https://kirha.com/providers/openfda.md)

FDA's quarterly lists of potential signals of serious risks or new safety information identified from FAERS, by drug name or class, with what FDA did since. Use for public US signals on a drug.

## Run it with the CLI

```bash
kirha tools run openfda_searchFaersPotentialSignals \
  --input '{
    "drug": "<drug>"
  }'
```

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

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": {
    "drug": {
      "description": "Trade name, active ingredient or class",
      "minLength": 2,
      "type": "string"
    },
    "limit": {
      "default": 20,
      "maximum": 50,
      "minimum": 1,
      "type": "integer"
    },
    "postedAfter": {
      "description": "Quarters ending on or after this date",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
      "type": "string"
    }
  },
  "required": [
    "drug"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "earliestQuarter": {
      "type": [
        "string",
        "null"
      ]
    },
    "quartersRead": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "quartersUnread": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "signals": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "additionalInformation": {
            "description": "What FDA did since, as of asOf",
            "type": "string"
          },
          "asOf": {
            "type": [
              "string",
              "null"
            ]
          },
          "products": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "quarter": {
            "type": "string"
          },
          "quarterFrom": {
            "type": "string"
          },
          "quarterTo": {
            "type": "string"
          },
          "signal": {
            "type": "string"
          },
          "sourceUrl": {
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "quarter",
          "quarterFrom",
          "quarterTo",
          "products",
          "signal",
          "additionalInformation",
          "asOf",
          "sourceUrl"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "total": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    }
  },
  "required": [
    "context",
    "total",
    "quartersRead",
    "quartersUnread",
    "earliestQuarter",
    "signals"
  ],
  "type": "object"
}
```

-----

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