{ "openapi": "3.0.1", "info": { "title": "OpenFDA Drug Safety Finder", "description": "Search official openFDA APIs for FAERS adverse events, drug labels, and drug recalls, and save one flat row per record. No FDA website scraping and no login.", "version": "0.1", "x-build-id": "BIV3zqMyHjgleZTXs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shayuyuyuyu~openfda-drug-safety-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shayuyuyuyu-openfda-drug-safety-finder", "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/shayuyuyuyu~openfda-drug-safety-finder/runs": { "post": { "operationId": "runs-sync-shayuyuyuyu-openfda-drug-safety-finder", "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/shayuyuyuyu~openfda-drug-safety-finder/run-sync": { "post": { "operationId": "run-sync-shayuyuyuyu-openfda-drug-safety-finder", "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", "required": [ "mode" ], "properties": { "search": { "title": "Search", "type": "string", "description": "A plain drug, brand, or ingredient name, or an openFDA search expression. A plain value such as aspirin is quoted and OR-ed across the name fields for the selected mode (medicinal product, brand, generic, and substance; recalls also search product description). A value that already contains field:term syntax, such as patient.drug.medicinalproduct:aspirin or openfda.brand_name:\"tylenol extra strength\", is sent to openFDA unchanged. Required unless you set a brand, generic, or substance name. Do not put an API key here." }, "mode": { "title": "Mode", "enum": [ "event", "label", "recall" ], "type": "string", "description": "Which official openFDA dataset to query. event reads FAERS adverse event reports (/drug/event.json). label reads Structured Product Labeling (/drug/label.json). recall reads drug enforcement reports (/drug/enforcement.json).", "default": "event" }, "brandName": { "title": "Brand name", "type": "string", "description": "Optional brand name. Used only when Search is empty. OR-ed with generic name and substance name. Example: Tylenol." }, "genericName": { "title": "Generic name", "type": "string", "description": "Optional generic name. Used only when Search is empty. Example: acetaminophen." }, "substanceName": { "title": "Substance name", "type": "string", "description": "Optional active substance. Used only when Search is empty. Example: ibuprofen." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of flat rows to save. openFDA chooses the order after the Actor sorts by the dataset date, newest first.", "default": 50 }, "apiKey": { "title": "openFDA API key", "type": "string", "description": "Optional free openFDA API key. Without a key the public limit is 240 requests per minute and 1,000 requests per day per IP. With a key the daily limit is 120,000 requests. The key is sent only as the api_key query parameter to api.fda.gov and is never written to the dataset, the run overview, or the logs. Create one at https://open.fda.gov/apis/authentication/." }, "skip": { "title": "Skip", "minimum": 0, "maximum": 25000, "type": "integer", "description": "How many matching openFDA records to skip before saving. Use this to resume a larger result set. openFDA allows skip up to 25000. Leave at 0 for a normal run.", "default": 0 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }