{ "openapi": "3.0.1", "info": { "title": "openFDA Drug Labels (SPL) Scraper", "description": "Export the openFDA Structured Product Labeling drug-label corpus as clean, flat rows — filterable by brand name, generic name, manufacturer, product NDC, or route, with control over which label sections (active ingredient, warnings, dosage, and more) land in your dataset as JSON, CSV, or Excel.", "version": "0.1", "x-build-id": "70tgH4ppdisYYcN3h" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devilscrapes~openfda-drug-labels-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devilscrapes-openfda-drug-labels-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/devilscrapes~openfda-drug-labels-scraper/runs": { "post": { "operationId": "runs-sync-devilscrapes-openfda-drug-labels-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/devilscrapes~openfda-drug-labels-scraper/run-sync": { "post": { "operationId": "run-sync-devilscrapes-openfda-drug-labels-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": { "brandName": { "title": "Brand name", "type": "string", "description": "Filter: brand name (matches openfda.brand_name). Only field with a prefill value in this Actor — combine with other filters cautiously since all set filters are ANDed together." }, "genericName": { "title": "Generic name", "type": "string", "description": "Filter: generic name (matches openfda.generic_name)." }, "manufacturerName": { "title": "Manufacturer name", "type": "string", "description": "Filter: manufacturer name (matches openfda.manufacturer_name)." }, "productNdc": { "title": "Product NDC", "type": "string", "description": "Filter: product NDC code (matches openfda.product_ndc)." }, "route": { "title": "Route", "type": "string", "description": "Filter: administration route (matches openfda.route), e.g. ORAL." }, "searchQuery": { "title": "Raw search query", "type": "string", "description": "Raw openFDA search expression, ANDed with the structured filters above (same convention as fda-510k-clearances-scraper). Leave empty to skip." }, "fields": { "title": "Label sections to include", "type": "array", "description": "Which label content sections to populate in each output row. openfda identity fields (brand/generic name, manufacturer, NDC, route, substance, application number) and id/set_id/version/effective_time are always included regardless of this selection.", "items": { "type": "string", "enum": [ "active_ingredient", "purpose", "indications_and_usage", "warnings", "do_not_use", "ask_doctor", "ask_doctor_or_pharmacist", "when_using", "stop_use", "pregnancy_or_breast_feeding", "keep_out_of_reach_of_children", "dosage_and_administration", "storage_and_handling", "inactive_ingredient", "questions", "package_label_principal_display_panel" ] }, "default": [ "active_ingredient", "purpose", "indications_and_usage", "warnings" ] }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Stop after this many records. Each record is one billed result row.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "openFDA is a public keyless government API and does not need a proxy. Leave this off unless your account requires egress through Apify Proxy.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }