{ "openapi": "3.0.1", "info": { "title": "openFDA Drug Enforcement Reports Scraper", "description": "Monitor FDA drug enforcement and recall reports by classification, status, firm, product, geography, and dates from the official openFDA API.", "version": "0.1", "x-build-id": "6FzIH6jhbcIPXuuBP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~openfda-drug-enforcement-reports-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-openfda-drug-enforcement-reports-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-enforcement-reports-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-openfda-drug-enforcement-reports-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-enforcement-reports-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-openfda-drug-enforcement-reports-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": { "search": { "title": "Free-text search", "type": "string", "description": "Search product descriptions, recall reasons, recalling firms, and distribution patterns." }, "classification": { "title": "Recall classification", "enum": [ "", "Class I", "Class II", "Class III" ], "type": "string", "description": "Filter by FDA classification, for example Class I, Class II, or Class III." }, "status": { "title": "Recall status", "enum": [ "", "Ongoing", "Completed", "Terminated" ], "type": "string", "description": "Filter by recall status such as Ongoing, Completed, or Terminated." }, "state": { "title": "State", "type": "string", "description": "Two-letter US state code of the recalling firm, for example CA or NY." }, "country": { "title": "Country", "type": "string", "description": "Country of the recalling firm." }, "recallingFirm": { "title": "Recalling firm", "type": "string", "description": "Exact or partial recalling firm name." }, "productDescription": { "title": "Product description contains", "type": "string", "description": "Filter FDA product_description for a drug/product term." }, "productType": { "title": "Product type", "type": "string", "description": "openFDA product_type value. Drug enforcement reports typically use Drugs." }, "recallNumber": { "title": "Recall number", "type": "string", "description": "FDA recall number, for example D-1234-2024." }, "eventId": { "title": "Event ID", "type": "string", "description": "FDA enforcement event_id." }, "reportDateFrom": { "title": "Report date from", "type": "string", "description": "Earliest FDA report_date. Use YYYY-MM-DD or YYYYMMDD." }, "reportDateTo": { "title": "Report date to", "type": "string", "description": "Latest FDA report_date. Use YYYY-MM-DD or YYYYMMDD." }, "recallInitiationDateFrom": { "title": "Recall initiation date from", "type": "string", "description": "Earliest recall_initiation_date. Use YYYY-MM-DD or YYYYMMDD." }, "recallInitiationDateTo": { "title": "Recall initiation date to", "type": "string", "description": "Latest recall_initiation_date. Use YYYY-MM-DD or YYYYMMDD." }, "terminationDateFrom": { "title": "Termination date from", "type": "string", "description": "Earliest termination_date. Use YYYY-MM-DD or YYYYMMDD." }, "terminationDateTo": { "title": "Termination date to", "type": "string", "description": "Latest termination_date. Use YYYY-MM-DD or YYYYMMDD." }, "maxItems": { "title": "Maximum reports", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum enforcement reports to save to the dataset.", "default": 20 }, "apiKey": { "title": "openFDA API key (optional)", "type": "string", "description": "Optional openFDA API key for higher rate limits. Leave blank for normal small and medium exports." } } }, "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 } } } } } } } } } }