{ "openapi": "3.0.1", "info": { "title": "openFDA Scraper: Drug Events, Recalls & Device Reports", "description": "Query openFDA for adverse event reports, enforcement actions and recalls across drugs, devices, food and tobacco. Filter by product, date and free-text search.", "version": "0.0", "x-build-id": "pFsMSE3g8rbZWqbzm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arman-bd~openfda-adverse-events-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arman-bd-openfda-adverse-events-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/arman-bd~openfda-adverse-events-scraper/runs": { "post": { "operationId": "runs-sync-arman-bd-openfda-adverse-events-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/arman-bd~openfda-adverse-events-scraper/run-sync": { "post": { "operationId": "run-sync-arman-bd-openfda-adverse-events-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": { "domain": { "title": "Domain", "enum": [ "drug", "device", "food", "tobacco" ], "type": "string", "description": "Which FDA centre's data to read. Not every endpoint exists in every domain, so check the endpoint field below.", "default": "drug" }, "endpoint": { "title": "Endpoint", "enum": [ "event", "enforcement", "label", "recall", "problem" ], "type": "string", "description": "Valid pairs are drug/event, drug/enforcement, drug/label, device/event, device/enforcement, device/recall, food/event, food/enforcement and tobacco/problem. Any other combination stops the run with an error naming the valid ones.", "default": "event" }, "productNames": { "title": "Product names", "type": "array", "description": "Brand or generic names. Each name is queried separately against the endpoint's own product field and tagged as productQuery in the output. Leave empty to search the whole dataset.", "items": { "type": "string" } }, "searchQuery": { "title": "Search expression", "type": "string", "description": "A raw openFDA search expression, for example patient.reaction.reactionmeddrapt:\"nausea\". It is ANDed with the product name and date filters. Leave empty to filter on those alone." }, "fromDate": { "title": "From date", "type": "string", "description": "Lower bound on the endpoint's own date field (receivedate for drug events, report_date for enforcement, and so on). YYYY-MM-DD or YYYYMMDD. Empty means no lower bound." }, "toDate": { "title": "To date", "type": "string", "description": "Upper bound on the same date field. YYYY-MM-DD or YYYYMMDD. Empty means no upper bound." }, "maxResults": { "title": "Max results per product", "minimum": 1, "maximum": 25100, "type": "integer", "description": "Cap on records saved for each product name, or for the whole run when no product is given. openFDA refuses to page past 25,000 records for one query, which is the hard ceiling.", "default": 100 }, "apiKey": { "title": "openFDA API key", "type": "string", "description": "Optional. Without a key openFDA allows 240 requests per minute and 1,000 per day per IP; a free key raises that to 240 per minute and 120,000 per day. Get one at open.fda.gov/apis/authentication." } } }, "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 } } } } } } } } } }