{ "openapi": "3.0.1", "info": { "title": "openFDA Drug Safety Profile", "description": "Per-drug openFDA profile: reported adverse events, boxed warning and recalls by class. Reports do not show a drug caused an event. Not medical advice. Official API.", "version": "0.1", "x-build-id": "6aXtwpanZ5pUSAtmW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/a.jonzy~openfda-drug-safety-profile/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-a.jonzy-openfda-drug-safety-profile", "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/a.jonzy~openfda-drug-safety-profile/runs": { "post": { "operationId": "runs-sync-a.jonzy-openfda-drug-safety-profile", "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/a.jonzy~openfda-drug-safety-profile/run-sync": { "post": { "operationId": "run-sync-a.jonzy-openfda-drug-safety-profile", "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": [ "drugs" ], "properties": { "drugs": { "title": "Drug names", "type": "array", "description": "Generic, brand or substance names, one per entry, for example metformin or Lipitor. One profile is returned per drug. Up to 200 per run.", "items": { "type": "string" } }, "sections": { "title": "Sections", "type": "array", "description": "What to include. Allowed values: events (FAERS adverse event counts), label (boxed warning, indications, contraindications), recalls (FDA drug enforcement reports). Defaults to all three. Fewer sections use fewer of the openFDA daily request allowance.", "items": { "type": "string" } }, "receivedFrom": { "title": "Reports received from", "type": "string", "description": "Optional start date for adverse event reports, YYYY-MM-DD. Applies to the events section only." }, "receivedTo": { "title": "Reports received to", "type": "string", "description": "Optional end date for adverse event reports, YYYY-MM-DD. Applies to the events section only." }, "topReactions": { "title": "Top reactions per drug", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many of the most reported reactions (MedDRA preferred terms) to list, 1 to 100.", "default": 15 }, "recentRecalls": { "title": "Recent recalls per drug", "minimum": 0, "maximum": 50, "type": "integer", "description": "How many of the most recent recall reports to list, 0 to 50. Recall totals by class are always included.", "default": 5 }, "openFdaApiKey": { "title": "openFDA API key (optional)", "type": "string", "description": "A free key from open.fda.gov raises the limit from 1,000 to 120,000 requests per day. Without one, openFDA allows 1,000 requests per day per IP address, shared with other users of the same Apify IP, and a profile uses up to 7 requests." } } }, "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 } } } } } } } } } }