# OpenFDA Drug Adverse Events Search (`scrupulous_waterbird_m4w/openfda-drug-events`) Actor

Search public FDA FAERS drug adverse-event reports by drug name, raw query, and received-date range. Export normalized safety reports with patient, drug, reaction, and serious-event fields.

- **URL**: https://apify.com/scrupulous\_waterbird\_m4w/openfda-drug-events.md
- **Developed by:** [Mori](https://apify.com/scrupulous_waterbird_m4w) (community)
- **Categories:** Other, AI, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## OpenFDA Drug Adverse Events Search

Search the [openFDA FAERS](https://open.fda.gov/data/faers/) drug adverse-event endpoint and export normalized safety-report records from the US FDA public dataset.

This Actor wraps the public `https://api.fda.gov/drug/event.json` endpoint. No API key is required (openFDA's documented rate limits apply, with optional `apiKey` input to lift the per-IP cap).

### What it returns

One normalized record per FAERS safety report, with patient, drug, reaction, and serious-flag fields flattened. Use `includeRaw=true` to also persist the full openFDA record for downstream debugging.

### Inputs

| Field | Type | Default | Notes |
|---|---|---|---|
| `drugName` | string | `aspirin` | Free-text drug name; translated to `patient.drug.medicinalproduct:<value>` |
| `search` | string | `""` | Raw openFDA search expression. Overrides `drugName` when set |
| `startDate` | string (YYYYMMDD) | `""` | Inclusive lower bound for `receivedate` |
| `endDate` | string (YYYYMMDD) | `""` | Inclusive upper bound for `receivedate` |
| `maxItems` | integer | `100` | Cap on records exported (max 1000) |
| `pageSize` | integer | `100` | Records per request (max 1000) |
| `sort` | enum | `receivedate:desc` | openFDA sort field |
| `includeRaw` | boolean | `false` | Include the full raw openFDA record under `raw` |

### Examples

- **All aspirin events (latest 5):** leave defaults at `maxItems=5`.
- **Metformin events for 2024 only:**
  - `drugName=metformin`, `startDate=20240101`, `endDate=20241231`, `maxItems=20`
- **Custom raw query:**
  - `search=patient.reaction.reactionmeddrapt:headache AND receivedate:[20240101 TO 20241231]`

### Compliance notes

openFDA is a US government public dataset; terms of use apply. See https://open.fda.gov/terms/. This Actor exposes public, anonymized safety reports only. It is for research/engineering use, not medical advice.

### Local development

```bash
make install          # one-time: install apify SDK
make run              # local scrape test (reads .actor/input.json)
make push             # build Docker image + push to Apify
````

To override the openFDA per-IP rate cap, register a free key at https://open.fda.gov and pass it via input field `apiKey`.

# Actor input Schema

## `drugName` (type: `string`):

Free-text drug name (e.g. aspirin, ibuprofen, atorvastatin). Translated to patient.drug.medicinalproduct:<value>. Ignored when `search` is set.

## `search` (type: `string`):

Optional raw openFDA search query (e.g. 'patient.drug.medicinalproduct:metformin AND receivedate:\[20240101 TO 20241231]'). Overrides drugName when set.

## `startDate` (type: `string`):

Optional inclusive lower bound for receivedate. Must be in YYYYMMDD format. Appended to the search expression with receivedate:>=.

## `endDate` (type: `string`):

Optional inclusive upper bound for receivedate. Must be in YYYYMMDD format. Appended to the search expression with receivedate:<=.

## `maxItems` (type: `integer`):

Cap on total records exported. The openFDA limit per request is 1000; we cap at 1000 to respect that.

## `pageSize` (type: `integer`):

Records fetched per /drug/event.json request. openFDA accepts up to 1000. We default to 100 to balance latency and request count.

## `sort` (type: `string`):

openFDA sort field, e.g. 'receivedate:desc'. Leave empty to skip server-side sorting.

## `includeRaw` (type: `boolean`):

If true, include the raw openFDA record JSON under `raw` for downstream debugging. Adds bulk to the dataset.

## Actor input object example

```json
{
  "drugName": "aspirin",
  "search": "",
  "startDate": "",
  "endDate": "",
  "maxItems": 100,
  "pageSize": 100,
  "sort": "receivedate:desc",
  "includeRaw": false
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("scrupulous_waterbird_m4w/openfda-drug-events").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("scrupulous_waterbird_m4w/openfda-drug-events").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call scrupulous_waterbird_m4w/openfda-drug-events --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=scrupulous_waterbird_m4w/openfda-drug-events",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "OpenFDA Drug Adverse Events Search",
        "description": "Search public FDA FAERS drug adverse-event reports by drug name, raw query, and received-date range. Export normalized safety reports with patient, drug, reaction, and serious-event fields.",
        "version": "0.0",
        "x-build-id": "LrmSLRhzVfbr0iLhk"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/scrupulous_waterbird_m4w~openfda-drug-events/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-scrupulous_waterbird_m4w-openfda-drug-events",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/scrupulous_waterbird_m4w~openfda-drug-events/runs": {
            "post": {
                "operationId": "runs-sync-scrupulous_waterbird_m4w-openfda-drug-events",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/scrupulous_waterbird_m4w~openfda-drug-events/run-sync": {
            "post": {
                "operationId": "run-sync-scrupulous_waterbird_m4w-openfda-drug-events",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "drugName": {
                        "title": "Drug name",
                        "type": "string",
                        "description": "Free-text drug name (e.g. aspirin, ibuprofen, atorvastatin). Translated to patient.drug.medicinalproduct:<value>. Ignored when `search` is set.",
                        "default": "aspirin"
                    },
                    "search": {
                        "title": "Raw openFDA search expression",
                        "type": "string",
                        "description": "Optional raw openFDA search query (e.g. 'patient.drug.medicinalproduct:metformin AND receivedate:[20240101 TO 20241231]'). Overrides drugName when set.",
                        "default": ""
                    },
                    "startDate": {
                        "title": "Start date (YYYYMMDD)",
                        "type": "string",
                        "description": "Optional inclusive lower bound for receivedate. Must be in YYYYMMDD format. Appended to the search expression with receivedate:>=.",
                        "default": ""
                    },
                    "endDate": {
                        "title": "End date (YYYYMMDD)",
                        "type": "string",
                        "description": "Optional inclusive upper bound for receivedate. Must be in YYYYMMDD format. Appended to the search expression with receivedate:<=.",
                        "default": ""
                    },
                    "maxItems": {
                        "title": "Max items",
                        "minimum": 1,
                        "maximum": 1000,
                        "type": "integer",
                        "description": "Cap on total records exported. The openFDA limit per request is 1000; we cap at 1000 to respect that.",
                        "default": 100
                    },
                    "pageSize": {
                        "title": "Records per request",
                        "minimum": 1,
                        "maximum": 1000,
                        "type": "integer",
                        "description": "Records fetched per /drug/event.json request. openFDA accepts up to 1000. We default to 100 to balance latency and request count.",
                        "default": 100
                    },
                    "sort": {
                        "title": "Sort field",
                        "enum": [
                            "",
                            "receivedate:desc",
                            "receivedate:asc",
                            "transmissiondate:desc",
                            "transmissiondate:asc"
                        ],
                        "type": "string",
                        "description": "openFDA sort field, e.g. 'receivedate:desc'. Leave empty to skip server-side sorting.",
                        "default": "receivedate:desc"
                    },
                    "includeRaw": {
                        "title": "Include raw record",
                        "type": "boolean",
                        "description": "If true, include the raw openFDA record JSON under `raw` for downstream debugging. Adds bulk to the dataset.",
                        "default": false
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
