{ "openapi": "3.0.1", "info": { "title": "openFDA Drug Adverse Event Scraper", "description": "💊 Export FDA FAERS/openFDA drug adverse event reports by drug, reaction, manufacturer, country, date, and seriousness.", "version": "0.1", "x-build-id": "jU4RUSZgRo6Yuz6Ky" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~openfda-drug-adverse-event-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-openfda-drug-adverse-event-scraper", "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/automation-lab~openfda-drug-adverse-event-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-openfda-drug-adverse-event-scraper", "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/automation-lab~openfda-drug-adverse-event-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-openfda-drug-adverse-event-scraper", "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": { "searchTerms": { "title": "Drug names or active ingredients", "type": "array", "description": "Drug/product names searched in patient.drug.medicinalproduct. Examples: aspirin, metformin, ozempic.", "items": { "type": "string" } }, "drugName": { "title": "Additional exact drug name", "type": "string", "description": "Optional single drug/product name filter appended to the search terms." }, "reactionTerm": { "title": "Reaction term (MedDRA)", "type": "string", "description": "Optional MedDRA preferred term, such as nausea, rash, myocardial infarction, or headache." }, "manufacturerName": { "title": "Manufacturer name", "type": "string", "description": "Optional manufacturer/sponsor name from openFDA manufacturer_name fields." }, "country": { "title": "Country code", "type": "string", "description": "Optional 2-letter country code matched against occurrence or primary source country, e.g. US, CA, GB." }, "dateFrom": { "title": "Received date from", "type": "string", "description": "Lower bound for FDA receivedate. Use YYYY-MM-DD or YYYYMMDD." }, "dateTo": { "title": "Received date to", "type": "string", "description": "Upper bound for FDA receivedate. Use YYYY-MM-DD or YYYYMMDD." }, "seriousness": { "title": "Seriousness", "enum": [ "all", "serious", "non_serious" ], "type": "string", "description": "Filter reports by serious/non-serious flag, or return all reports.", "default": "all" }, "rawSearch": { "title": "Raw openFDA search expression", "type": "string", "description": "Advanced search expression appended with AND. Use official openFDA syntax only when needed." }, "sort": { "title": "Sort order", "enum": [ "receivedate:desc", "receivedate:asc", "transmissiondate:desc", "transmissiondate:asc" ], "type": "string", "description": "openFDA sort parameter used for pagination.", "default": "receivedate:desc" }, "maxItems": { "title": "Maximum reports", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Maximum adverse event reports to save. openFDA skip pagination is capped for very large exports.", "default": 20 }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Reports requested per openFDA API call. Maximum 1000.", "default": 20 } } }, "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 } } } } } } } } } }