# Openfda Drug Us (`dromb/openfda-drug-us`) Actor OpenFDA Drug US Scraper extracts structured US drug product data from the official public openFDA drug APIs. - **URL**: https://apify.com/dromb/openfda-drug-us.md - **Developed by:** [Dmitriy Gyrbu](https://apify.com/dromb) (community) - **Categories:** Automation, Developer tools, Other - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.60 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## OpenFDA Drug US Scraper OpenFDA Drug US Scraper extracts structured US drug product data from the official public openFDA drug APIs. Use it for NDC lookup, regulatory product research, label review, approval-data enrichment, market analysis, and lightweight health checks. This actor is not affiliated with the FDA or openFDA. It uses public data from `api.fda.gov` and does not require proxies. ### Supported operations - `probe`: checks openFDA availability with a small NDC request. - `categories`: lists high-volume browse categories for product type, route, dosage form, and marketing category. - `filters`: returns filter metadata and lookup-key guidance. - `search`: searches the openFDA NDC dataset by query or exact filters. - `category`: browses NDC products by `category_id` in `group:value` format. - `item`: returns an enriched product profile from NDC data with optional label and Drugs@FDA approval data. ### Input guide `operation` is required. For `search`, provide `query` or at least one exact filter such as `brand`, `generic_name`, `manufacturer`, `dosage_form`, `route`, `product_type`, `marketing_category`, or `application_number`. For `item`, provide one of `product_ndc`, `set_id`, `application_number`, or `item_id`. `include_label` and `include_approval` default to `true`. `limit` defaults to `25` and is capped at `100`. `page` is 1-based. ### Example inputs Probe: ```json { "operation": "probe" } ```` Search: ```json { "operation": "search", "query": "aspirin", "limit": 5 } ``` Search with exact filter: ```json { "operation": "search", "route": "ORAL", "dosage_form": "TABLET", "limit": 5 } ``` Category browse: ```json { "operation": "category", "category_id": "route:ORAL", "limit": 5 } ``` Item detail: ```json { "operation": "item", "product_ndc": "21130-481" } ``` ### Output For monetization and result counting, each useful result is written as its own Apify dataset item. Search limit `5` writes `5` dataset items, and item lookup writes `1` dataset item when the product is found. Run status, totals, no-result summaries, and error summaries are written to the default key-value store under `OUTPUT`. Probe, no-result searches, invalid item lookups, and invalid inputs do not create fake dataset result rows. Search and category results can include: - `status`, `source`, `operation`, `mode`, `record_type` - `id`, `item_id`, `product_ndc`, `set_id` - `name`, `brand`, `generic_name`, `manufacturer` - `product_type`, `dosage_form`, `route`, `marketing_category` - `application_number` - `active_ingredients` - `package_count` - `source_dataset`, `source_urls` Item results extend listing fields with: - `description`, `short_description` - `ingredients`, `inactive_ingredients` - `usage_instructions`, `warnings`, `benefits` - `packaging` - `sections` - `label_available`, `approval_available` - `openfda` - `approval` - `source_datasets`, `source_urls` No-result searches write zero dataset items and return `status: "success"` with `dataset_item_count: 0` in `OUTPUT`. Invalid item lookups write zero dataset items and return `status: "not_found"` with a structured error object in `OUTPUT`. ### Limitations - Data freshness, coverage, and field availability are controlled by openFDA. - Some NDC records do not have matching label or Drugs@FDA approval records. - The openFDA public API may rate-limit heavy usage. - This actor does not provide medical advice and should not be used as a substitute for official labeling review by qualified professionals. ### Proxy behavior No proxy is required. The actor performs direct HTTPS requests to public openFDA endpoints. # Actor input Schema ## `operation` (type: `string`): The operation to perform: probe, categories, filters, search, category, item ## `query` (type: `string`): General search query for brand, generic, manufacturer, or substance. ## `brand` (type: `string`): Exact brand name. ## `generic_name` (type: `string`): Exact generic name. ## `manufacturer` (type: `string`): Exact manufacturer name. ## `dosage_form` (type: `string`): Exact dosage form. ## `route` (type: `string`): Exact route of administration. ## `product_type` (type: `string`): Exact product type. ## `marketing_category` (type: `string`): Exact marketing category. ## `application_number` (type: `string`): Exact application number. ## `category_id` (type: `string`): Category ID in format group:value (e.g., route:ORAL). ## `product_ndc` (type: `string`): Exact NDC listing code. ## `set_id` (type: `string`): Exact SPL set id. ## `item_id` (type: `string`): Alias for NDC or set ID. ## `page` (type: `integer`): 1-based page number. ## `limit` (type: `integer`): Results per page (max 100). ## `include_label` (type: `boolean`): Whether to include label data. ## `include_approval` (type: `boolean`): Whether to include Drugs@FDA approval data. ## Actor input object example ```json { "operation": "search", "query": "ibuprofen", "page": 1, "limit": 25, "include_label": true, "include_approval": true } ``` # Actor output Schema ## `status` (type: `string`): Operation status: success, invalid\_input, not\_found, blocked, or error. ## `source` (type: `string`): Stable source key. ## `operation` (type: `string`): Requested operation. ## `mode` (type: `string`): Internal operation mode or source dataset. ## `query` (type: `string`): Search query when applicable. ## `page` (type: `string`): 1-based page number. ## `limit` (type: `string`): Requested page size. ## `total` (type: `string`): Total matching records reported by openFDA, or 0 for errors. ## `matched_by` (type: `string`): Lookup strategy that matched an item request. ## `record_type` (type: `string`): Dataset row type, such as drug\_listing, drug\_item, category, or filter\_group. ## `product_ndc` (type: `string`): FDA NDC product code. ## `brand` (type: `string`): Brand name when available. ## `generic_name` (type: `string`): Generic name when available. ## `manufacturer` (type: `string`): Labeler or manufacturer name. ## `product_type` (type: `string`): openFDA product type. ## `dosage_form` (type: `string`): Drug dosage form. ## `route` (type: `string`): Administration route values. ## `active_ingredients` (type: `string`): Active ingredient names and strengths. ## `label_available` (type: `string`): Whether label data was attached for an item row. ## `source_urls` (type: `string`): Official openFDA API source URLs. ## `dataset` (type: `string`): API URL for all flat dataset result rows produced by the run. ## `summary` (type: `string`): Run status, totals, and empty/error summary stored under OUTPUT. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("dromb/openfda-drug-us").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("dromb/openfda-drug-us").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call dromb/openfda-drug-us --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=dromb/openfda-drug-us", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Openfda Drug Us", "description": "OpenFDA Drug US Scraper extracts structured US drug product data from the official public openFDA drug APIs.", "version": "0.1", "x-build-id": "4b7ifKh3gBhsKFfke" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dromb~openfda-drug-us/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dromb-openfda-drug-us", "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/dromb~openfda-drug-us/runs": { "post": { "operationId": "runs-sync-dromb-openfda-drug-us", "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/dromb~openfda-drug-us/run-sync": { "post": { "operationId": "run-sync-dromb-openfda-drug-us", "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": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "probe", "categories", "filters", "search", "category", "item" ], "type": "string", "description": "The operation to perform: probe, categories, filters, search, category, item", "default": "search" }, "query": { "title": "Query", "type": "string", "description": "General search query for brand, generic, manufacturer, or substance.", "default": "ibuprofen" }, "brand": { "title": "Brand", "type": "string", "description": "Exact brand name." }, "generic_name": { "title": "Generic Name", "type": "string", "description": "Exact generic name." }, "manufacturer": { "title": "Manufacturer", "type": "string", "description": "Exact manufacturer name." }, "dosage_form": { "title": "Dosage Form", "type": "string", "description": "Exact dosage form." }, "route": { "title": "Route", "type": "string", "description": "Exact route of administration." }, "product_type": { "title": "Product Type", "type": "string", "description": "Exact product type." }, "marketing_category": { "title": "Marketing Category", "type": "string", "description": "Exact marketing category." }, "application_number": { "title": "Application Number", "type": "string", "description": "Exact application number." }, "category_id": { "title": "Category ID", "type": "string", "description": "Category ID in format group:value (e.g., route:ORAL)." }, "product_ndc": { "title": "Product NDC", "type": "string", "description": "Exact NDC listing code." }, "set_id": { "title": "Set ID", "type": "string", "description": "Exact SPL set id." }, "item_id": { "title": "Item ID", "type": "string", "description": "Alias for NDC or set ID." }, "page": { "title": "Page", "type": "integer", "description": "1-based page number.", "default": 1 }, "limit": { "title": "Limit", "type": "integer", "description": "Results per page (max 100).", "default": 25 }, "include_label": { "title": "Include Label", "type": "boolean", "description": "Whether to include label data.", "default": true }, "include_approval": { "title": "Include Approval", "type": "boolean", "description": "Whether to include Drugs@FDA approval data.", "default": true } } }, "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 } } } } } } } } } } ```