# NPI/NPPES Healthcare Provider Scraper (`parseforge/npi-nppes-scraper`) Actor Supercharge your healthcare provider research with our NPI/NPPES Scraper! Automate comprehensive data collection from the National Plan and Provider Enumeration System (NPPES) Registry, saving hours of manual research and ensuring you get the most accurate, up-to-date healthcare provider information - **URL**: https://apify.com/parseforge/npi-nppes-scraper.md - **Developed by:** [ParseForge](https://apify.com/parseforge) (community) - **Categories:** Automation, Developer tools, Lead generation - **Stats:** 46 total users, 2 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing Pay per event This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. 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 ![ParseForge Banner](https://github.com/ParseForge/apify-assets/blob/ad35ccc13ddd068b9d6cba33f323962e39aed5b2/banner.jpg?raw=true) ## ๐Ÿฅ NPI/NPPES Healthcare Provider Scraper > ๐Ÿš€ **Collect healthcare provider data from the NPPES registry in minutes.** Search by NPI number, name, specialty, city, state, or ZIP code. Export provider profiles, credentials, and contact info. No coding, no CMS account required. > ๐Ÿ•’ **Last updated:** 2026-04-23 ยท **๐Ÿ“Š 30+ fields** per provider ยท **๐Ÿ” 10 search filters** ยท **๐Ÿฅ Individual + organization** ยท **๐Ÿšซ No auth** required The **NPI/NPPES Healthcare Provider Scraper** collects verified provider data from CMS's National Plan and Provider Enumeration System, returning **30+ fields per provider**: NPI number, name, credentials, specialty taxonomy, practice address, mailing address, phone, fax, enumeration date, and organization details. Runs support up to 1,000,000 records on a paid plan. The Actor queries the official NPPES API with 10 search filters: NPI number, first name, last name, city, state, ZIP code, taxonomy/specialty, and enumeration type (individual NPI-1 or organization NPI-2). Results come directly from CMS's public registry. | ๐ŸŽฏ Target Audience | ๐Ÿ’ก Primary Use Cases | |---|---| | Healthcare compliance teams, insurance companies, hospital credentialing, health-tech platforms, pharmaceutical reps, researchers | Provider verification, credentialing, referral network building, provider directory enrichment, compliance audits, sales targeting | --- ### ๐Ÿ“‹ What the NPI/NPPES Scraper does Direct NPPES API queries with 10 filters: - ๐Ÿ†” **NPI lookup.** Search by exact 10-digit NPI number. - ๐Ÿ‘ค **Name search.** First and last name for individual providers. - ๐Ÿ“ **Location filters.** City, state (2-letter code), and ZIP code. - ๐Ÿฅ **Specialty filter.** Taxonomy description (e.g. "Family Medicine", "Cardiology"). - ๐Ÿข **Enumeration type.** NPI-1 (individual) or NPI-2 (organization). Each provider record includes NPI, name, credentials, gender, taxonomy codes, practice address, mailing address, phone, fax, enumeration date, last update, and authorized official info (for organizations). > ๐Ÿ’ก **Why it matters:** manually looking up providers on the NPPES website means searching one at a time. This Actor exports verified CMS registry data in bulk, ready for your credentialing workflows, provider directories, or compliance databases. --- ### ๐ŸŽฌ Full Demo _๐Ÿšง Coming soon: a 3-minute walkthrough showing how to go from sign-up to a downloaded dataset._ --- ### โš™๏ธ Input
InputTypeDefaultBehavior
maxItemsinteger10Max providers. Free: limited. Paid: up to 1,000,000.
npistring""Exact 10-digit NPI number.
firstNamestring""Provider first name (individuals).
lastNamestring""Provider last name (individuals).
citystring""City name.
statestring""2-letter state code (e.g. "NY", "CA").
postalCodestring""5 or 9 digit ZIP code.
taxonomyDescriptionstring""Specialty (e.g. "Family Medicine", "Cardiology").
enumerationTypestring""NPI-1 (individual) or NPI-2 (organization).
**Example: cardiologists in New York state.** ```json { "taxonomyDescription": "Cardiology", "state": "NY", "enumerationType": "NPI-1", "maxItems": 100 } ```` **Example: lookup a specific NPI number.** ```json { "npi": "1234567890", "maxItems": 1 } ``` > โš ๏ธ **Good to Know:** the NPPES registry is maintained by CMS (Centers for Medicare & Medicaid Services). Data comes from the official NPPES API and reflects the current state of provider enrollments. *** ### ๐Ÿ“Š Output Each provider record contains **30+ fields**. Download the dataset as CSV, Excel, JSON, or XML. #### ๐Ÿงพ Schema (key fields) | Field | Type | Example | |---|---|---| | ๐Ÿ†” npi | string | `"1234567890"` | | ๐Ÿ‘ค firstName | string | `"John"` | | ๐Ÿ‘ค lastName | string | `"Smith"` | | ๐Ÿท๏ธ credentials | string | `"MD"` | | ๐Ÿฅ taxonomy | string | `"Internal Medicine - Cardiovascular Disease"` | | ๐Ÿ“ practiceAddress | string | `"123 Medical Ave, New York, NY 10001"` | | ๐Ÿ“ mailingAddress | string | `"PO Box 456, New York, NY 10002"` | | ๐Ÿ“ž phone | string | `"(212) 555-1234"` | | ๐Ÿ“  fax | string | `"(212) 555-5678"` | | ๐Ÿข enumerationType | string | `"NPI-1"` | | ๐Ÿ“… enumerationDate | string | `"2008-03-15"` | | ๐Ÿ“… lastUpdated | string | `"2026-01-10"` | | ๐Ÿท๏ธ gender | string | `"M"` | | ๐Ÿ•’ scrapedAt | ISO 8601 | `"2026-04-16T00:00:00.000Z"` | #### ๐Ÿ“ฆ Sample records
๐Ÿ‘จโ€โš•๏ธ Individual provider (NPI-1) ```json { "npi": "1234567890", "firstName": "John", "lastName": "Smith", "credentials": "MD", "taxonomy": "Internal Medicine - Cardiovascular Disease", "practiceAddress": "123 Medical Ave, New York, NY 10001", "mailingAddress": "PO Box 456, New York, NY 10002", "phone": "(212) 555-1234", "fax": "(212) 555-5678", "enumerationType": "NPI-1", "enumerationDate": "2008-03-15", "lastUpdated": "2026-01-10", "gender": "M", "scrapedAt": "2026-04-16T00:00:00.000Z" } ```
๐Ÿข Organization provider (NPI-2) ```json { "npi": "9876543210", "organizationName": "City Medical Group LLC", "taxonomy": "Multi-Specialty", "practiceAddress": "789 Health Blvd, Los Angeles, CA 90001", "mailingAddress": "789 Health Blvd, Los Angeles, CA 90001", "phone": "(323) 555-9876", "fax": null, "enumerationType": "NPI-2", "enumerationDate": "2012-06-20", "lastUpdated": "2025-11-05", "authorizedOfficialName": "Jane Doe", "authorizedOfficialTitle": "CEO", "scrapedAt": "2026-04-16T00:00:00.000Z" } ```
๐Ÿฅ Provider with sparse data ```json { "npi": "5555555555", "firstName": "Maria", "lastName": "Garcia", "credentials": "NP", "taxonomy": "Nurse Practitioner - Family", "practiceAddress": "Rural Health Clinic, Smalltown, TX 79001", "mailingAddress": null, "phone": "(806) 555-0001", "fax": null, "enumerationType": "NPI-1", "enumerationDate": "2020-09-01", "lastUpdated": "2020-09-01", "gender": "F", "scrapedAt": "2026-04-16T00:00:00.000Z" } ```
*** ### โœจ Why choose this Actor | | Capability | |---|---| | ๐Ÿ†” | **Official CMS data.** Queries the NPPES API directly for verified provider information. | | ๐Ÿ” | **10 search filters.** NPI, name, city, state, ZIP, specialty, and enumeration type. | | ๐Ÿฅ | **Individual and organization.** Both NPI-1 (providers) and NPI-2 (organizations). | | ๐Ÿ“ | **Full address data.** Practice and mailing addresses per provider. | | ๐Ÿ“ž | **Contact information.** Phone and fax per provider. | | โšก | **Scalable.** From single NPI lookups to full specialty-by-state sweeps. | | ๐Ÿšซ | **No authentication.** Uses the public NPPES API. No CMS account needed. | > ๐Ÿ“Š The NPPES registry contains over 8 million provider records. Structured access to this data powers every credentialing, compliance, and provider-directory workflow in U.S. healthcare. *** ### ๐Ÿ“ˆ How it compares to alternatives | Approach | Cost | Coverage | Refresh | Filters | Setup | |---|---|---|---|---|---| | **โญ NPI/NPPES Scraper** *(this Actor)* | $5 free credit, then pay-per-use | Full NPPES registry | **Live per run** | NPI, name, location, specialty, type | โšก 2 min | | NPPES website manual search | Free | One at a time | Manual | Basic UI | ๐Ÿ•’ Hours per batch | | NPPES full data download | Free | Full monthly file | Monthly | None (raw file) | โณ Hours of parsing | | Paid provider data platforms | $500-5,000/month | Multi-source | Varies | Many | ๐Ÿข Weeks | Pick this Actor when you want NPPES data on demand, with filters applied, without downloading and parsing the 8GB monthly file. *** ### ๐Ÿš€ How to use 1. ๐Ÿ“ **Sign up.** [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=vmoqkp) (takes 2 minutes). 2. ๐ŸŒ **Open the Actor.** Go to the NPI/NPPES Healthcare Provider Scraper page on the Apify Store. 3. ๐ŸŽฏ **Set input.** Enter a specialty, state, or NPI number. Set maxItems. 4. ๐Ÿš€ **Run it.** Click **Start** and let the Actor collect your data. 5. ๐Ÿ“ฅ **Download.** Grab your results in the **Dataset** tab as CSV, Excel, JSON, or XML. > โฑ๏ธ Total time from signup to downloaded dataset: **3-5 minutes.** No coding required. *** ### ๐Ÿ’ผ Business use cases
#### ๐Ÿฅ Credentialing & Compliance - Verify provider NPI and license status - Build credentialing databases by specialty - Monitor provider enrollment changes - Audit provider directories for accuracy #### ๐Ÿ“Š Health-Tech & Analytics - Enrich provider directories with NPI data - Build referral network maps by specialty - Power provider search and matching features - Analyze provider distribution by geography
#### ๐Ÿ’Š Pharmaceutical Sales - Build target lists by specialty and location - Identify providers in specific geographies - Track new provider enrollments - Segment by taxonomy for targeting #### ๐Ÿฆ Insurance & Payer Operations - Validate provider NPIs for claims processing - Build and maintain provider networks - Monitor provider status changes - Cross-reference with licensing databases
*** *** ### ๐ŸŒŸ Beyond business use cases Data like this powers more than commercial workflows. The same structured records support research, education, civic projects, and personal initiatives.
#### ๐ŸŽ“ Research and academia - Empirical datasets for papers, thesis work, and coursework - Longitudinal studies tracking changes across snapshots - Reproducible research with cited, versioned data pulls - Classroom exercises on data analysis and ethical scraping #### ๐ŸŽจ Personal and creative - Side projects, portfolio demos, and indie app launches - Data visualizations, dashboards, and infographics - Content research for bloggers, YouTubers, and podcasters - Hobbyist collections and personal trackers
#### ๐Ÿค Non-profit and civic - Transparency reporting and accountability projects - Advocacy campaigns backed by public-interest data - Community-run databases for local issues - Investigative journalism on public records #### ๐Ÿงช Experimentation - Prototype AI and machine-learning pipelines with real data - Validate product-market hypotheses before engineering spend - Train small domain-specific models on niche corpora - Test dashboard concepts with live input
### ๐Ÿค– Ask an AI assistant about this scraper Open a ready-to-send prompt about this ParseForge actor in the AI of your choice: - ๐Ÿ’ฌ [**ChatGPT**](https://chat.openai.com/?q=How%20do%20I%20use%20the%20NPI%2FNPPES%20Healthcare%20Provider%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - ๐Ÿง  [**Claude**](https://claude.ai/new?q=How%20do%20I%20use%20the%20NPI%2FNPPES%20Healthcare%20Provider%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - ๐Ÿ” [**Perplexity**](https://perplexity.ai/search?q=How%20do%20I%20use%20the%20NPI%2FNPPES%20Healthcare%20Provider%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - ๐Ÿ…’ [**Copilot**](https://copilot.microsoft.com/?q=How%20do%20I%20use%20the%20NPI%2FNPPES%20Healthcare%20Provider%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) ### โ“ Frequently Asked Questions
๐Ÿ’ณ Do I need a paid Apify plan to run this actor? No. You can start right now on the free Apify plan, which includes **$5 in free monthly credit**. That is enough to run this actor several times and explore the output before committing to anything. Paid plans unlock higher limits, more concurrent runs, and larger datasets. [Create a free Apify account here](https://console.apify.com/sign-up?fpr=vmoqkp) to get started.
๐Ÿšจ What happens if my run fails or returns no results? Failed runs are not charged. If the source site changes, proxies get rate-limited, or a specific input matches nothing, re-run the actor or open our [contact form](https://tally.so/r/BzdKgA) and we will investigate. You can also check the run log in the Apify console to see why the run stopped.
๐Ÿ“ How many items can I scrape per run? Free users are limited to **10 items per run** so you can preview the output and confirm the actor works for your use case. Paid users can raise maxItems up to **1,000,000** per run. [Upgrade here](https://console.apify.com/sign-up?fpr=vmoqkp) if you need full scale.
๐Ÿ•’ How fresh is the data? Every run fetches live data at the moment of execution. There is no cache or delay: the records you get reflect what the source returned at that moment. Schedule the actor to maintain a rolling snapshot of the data you need.
๐Ÿง‘โ€๐Ÿ’ป Can I call this actor from my own code? Yes. Apify exposes every actor as a REST endpoint and ships first-class SDKs for [Node.js](https://docs.apify.com/sdk/js) and [Python](https://docs.apify.com/sdk/python). You can start a run, read the dataset, and handle webhooks from your own app in a few lines. All you need is your Apify API token.
๐Ÿ“ค How do I export the data? Every Apify dataset can be downloaded in one click from the console as CSV, JSON, JSONL, Excel, HTML, XML, or RSS. You can also pull results programmatically via the [Apify API](https://docs.apify.com/api/v2) or stream them into BigQuery, S3, and other destinations through built-in integrations.
๐Ÿ“… Can I schedule the actor to run automatically? Yes. Use the Apify scheduler to run the actor on any cadence, from hourly to monthly. Results are saved to your dataset and can be delivered to webhooks, email, Slack, cloud storage, or automation tools such as Zapier and Make. ***
### ๐Ÿ”Œ Automating NPI/NPPES Scraper Control the scraper programmatically for scheduled runs and pipeline integrations: - ๐ŸŸข **Node.js.** Install the apify-client NPM package. - ๐Ÿ **Python.** Use the apify-client PyPI package. - ๐Ÿ“š See the [Apify API documentation](https://docs.apify.com/api/v2) for full details. The [Apify Schedules feature](https://docs.apify.com/platform/schedules) lets you trigger this Actor on any cron interval. Monthly pulls keep your provider database in sync with CMS records. ### ๐Ÿ”Œ Integrate with any app NPI/NPPES Scraper connects to any cloud service via [Apify integrations](https://apify.com/integrations): - [**Make**](https://docs.apify.com/platform/integrations/make) - Automate multi-step workflows - [**Zapier**](https://docs.apify.com/platform/integrations/zapier) - Connect with 5,000+ apps - [**Slack**](https://docs.apify.com/platform/integrations/slack) - Get run notifications in your channels - [**Airbyte**](https://docs.apify.com/platform/integrations/airbyte) - Pipe provider data into your warehouse - [**GitHub**](https://docs.apify.com/platform/integrations/github) - Trigger runs from commits and releases - [**Google Drive**](https://docs.apify.com/platform/integrations/drive) - Export datasets straight to Sheets *** ### ๐Ÿ”— Recommended Actors - [**๐Ÿฆ FINRA BrokerCheck Scraper**](https://apify.com/parseforge/finra-brokercheck-scraper) - Broker and firm regulatory data - [**๐Ÿ”ง CSLB California Contractor Scraper**](https://apify.com/parseforge/cslb-california-scraper) - California contractor licenses - [**๐Ÿ“‹ TDLR Texas License Scraper**](https://apify.com/parseforge/tdlr-texas-scraper) - Texas licensed professionals - [**๐Ÿ“Š RateMDs Scraper**](https://apify.com/parseforge/ratemds-scraper) - Doctor ratings and reviews - [**๐Ÿ“‹ Wyoming Business Scraper**](https://apify.com/parseforge/wyoming-business-scraper) - Business entity filings > ๐Ÿ’ก **Pro Tip:** browse the complete [ParseForge collection](https://apify.com/parseforge) for more healthcare and regulatory data scrapers. *** **๐Ÿ†˜ Need Help?** [**Open our contact form**](https://tally.so/r/BzdKgA) to request a new scraper, propose a custom data project, or report an issue. *** > **โš ๏ธ Disclaimer:** this Actor is an independent tool and is not affiliated with, endorsed by, or sponsored by CMS (Centers for Medicare & Medicaid Services) or the U.S. Department of Health and Human Services. All trademarks mentioned are the property of their respective owners. Only publicly available NPPES registry data is collected. # Actor input Schema ## `startUrl` (type: `string`): Direct NPPES API URL to scrape. Use this OR search filters below, not both. Example: https://npiregistry.cms.hhs.gov/api/?version=2.1\&first\_name=John\&state=NY ## `maxItems` (type: `integer`): Maximum number of providers to collect. Free users: Limited to 100. Paid users: Optional, max 1,000,000 ## `npi` (type: `string`): 10-digit National Provider Identifier number to search for ## `firstName` (type: `string`): Provider's first name (for individual providers) ## `lastName` (type: `string`): Provider's last name (for individual providers) ## `city` (type: `string`): City name where provider is located ## `state` (type: `string`): 2-letter state code (e.g., NY, CA, TX) ## `postalCode` (type: `string`): 5 or 9 digit ZIP code ## `taxonomyDescription` (type: `string`): Provider taxonomy/specialty description (e.g., Family Medicine, Cardiology) ## `enumerationType` (type: `string`): Provider type: NPI-1 for Individual, NPI-2 for Organization ## Actor input object example ```json { "maxItems": 10, "lastName": "Smith", "state": "NY" } ``` # Actor output Schema ## `providers` (type: `string`): Complete provider dataset with all fields including NPI number, provider name, addresses, taxonomy codes, and contact information ## `overview` (type: `string`): Overview view of providers with key fields displayed in a table format # 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 = { "maxItems": 10, "lastName": "Smith", "state": "NY" }; // Run the Actor and wait for it to finish const run = await client.actor("parseforge/npi-nppes-scraper").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 = { "maxItems": 10, "lastName": "Smith", "state": "NY", } # Run the Actor and wait for it to finish run = client.actor("parseforge/npi-nppes-scraper").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 '{ "maxItems": 10, "lastName": "Smith", "state": "NY" }' | apify call parseforge/npi-nppes-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=parseforge/npi-nppes-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "NPI/NPPES Healthcare Provider Scraper", "description": "Supercharge your healthcare provider research with our NPI/NPPES Scraper! Automate comprehensive data collection from the National Plan and Provider Enumeration System (NPPES) Registry, saving hours of manual research and ensuring you get the most accurate, up-to-date healthcare provider information", "version": "1.0", "x-build-id": "701z9Htch9N5EHsOB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~npi-nppes-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-npi-nppes-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/parseforge~npi-nppes-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-npi-nppes-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/parseforge~npi-nppes-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-npi-nppes-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": { "startUrl": { "title": "Start URL", "type": "string", "description": "Direct NPPES API URL to scrape. Use this OR search filters below, not both. Example: https://npiregistry.cms.hhs.gov/api/?version=2.1&first_name=John&state=NY" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of providers to collect. Free users: Limited to 100. Paid users: Optional, max 1,000,000" }, "npi": { "title": "NPI Number", "type": "string", "description": "10-digit National Provider Identifier number to search for" }, "firstName": { "title": "First Name", "type": "string", "description": "Provider's first name (for individual providers)" }, "lastName": { "title": "Last Name", "type": "string", "description": "Provider's last name (for individual providers)" }, "city": { "title": "City", "type": "string", "description": "City name where provider is located" }, "state": { "title": "State", "type": "string", "description": "2-letter state code (e.g., NY, CA, TX)" }, "postalCode": { "title": "Postal Code", "type": "string", "description": "5 or 9 digit ZIP code" }, "taxonomyDescription": { "title": "Taxonomy Description", "type": "string", "description": "Provider taxonomy/specialty description (e.g., Family Medicine, Cardiology)" }, "enumerationType": { "title": "Enumeration Type", "enum": [ "NPI-1", "NPI-2" ], "type": "string", "description": "Provider type: NPI-1 for Individual, NPI-2 for Organization" } } }, "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 } } } } } } } } } } ```