# OpenPayments Scraper (`parseforge/openpayments-scraper`) Actor Automate healthcare payment data collection from the CMS Open Payments database. Extract detailed financial relationships between providers and medical companies including research payments, general payments, and ownership interests. Ideal for researchers, compliance teams, and transparency work. - **URL**: https://apify.com/parseforge/openpayments-scraper.md - **Developed by:** [ParseForge](https://apify.com/parseforge) (community) - **Categories:** Automation, Developer tools, Other - **Stats:** 5 total users, 1 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) ## ๐Ÿ’Š OpenPayments Scraper > ๐Ÿš€ **Collect pharmaceutical payment data from CMS OpenPayments in minutes.** Search by provider, company, or payment type. Export payment amounts, dates, drug/device names, and payer info. No coding, no CMS account required. > ๐Ÿ•’ **Last updated:** 2026-04-23 ยท **๐Ÿ“Š 25+ fields** per payment ยท **๐Ÿ” Multi-filter search** ยท **๐Ÿ’ฐ Payment amounts** ยท **๐Ÿšซ No auth** required The **OpenPayments Scraper** collects pharmaceutical and medical device payment data from CMS's Open Payments database, returning **25+ fields per record**: physician name, payment amount, payer company, payment type (general, research, ownership), drug/device name, payment date, and teaching hospital info. Filter by provider, company, country, and search type. CMS Open Payments tracks billions in industry payments to physicians and hospitals. This Actor exports structured payment data for compliance, research, and transparency workflows. | ๐ŸŽฏ Target Audience | ๐Ÿ’ก Primary Use Cases | |---|---| | Compliance officers, pharmaceutical reps, healthcare researchers, journalists, patient advocacy groups | Sunshine Act compliance, conflict-of-interest research, pharmaceutical spending analysis, transparency reporting | --- ### ๐Ÿ“‹ What the OpenPayments Scraper does Multi-filter payment search: - ๐Ÿ”— **URL mode.** Paste any OpenPayments search URL. - ๐Ÿ” **Search type.** Individual providers or companies. - ๐Ÿ‘จโ€โš•๏ธ **Provider search.** Find payments to specific physicians. - ๐Ÿข **Company search.** Find payments from specific pharmaceutical/device companies. - ๐ŸŒ **Country filter.** Filter by provider country. Each payment record includes physician name, NPI, payment amount, payer company, payment type, drug/device name, nature of payment, payment date, and teaching hospital info. > ๐Ÿ’ก **Why it matters:** searching the CMS OpenPayments database manually means clicking through paginated results. This Actor exports structured payment data at scale for compliance audits, conflict-of-interest research, or pharmaceutical spending analysis. --- ### ๐ŸŽฌ Full Demo _๐Ÿšง Coming soon._ --- ### โš™๏ธ Input
InputTypeDefaultBehavior
startUrlstring""Direct OpenPayments URL.
searchTypestring""Individual provider or company.
maxItemsinteger10Max records. Paid: up to 1,000,000.
individualProviderCountrystring""Provider country filter.
**Example: payments to a specific physician.** ```json { "searchType": "individual", "startUrl": "https://openpaymentsdata.cms.gov/search/physicians/by-name-and-location?physician_first_name=John&physician_last_name=Smith", "maxItems": 50 } ```` *** ### ๐Ÿ“Š Output #### ๐Ÿงพ Schema | Field | Type | Example | |---|---|---| | ๐Ÿ‘จโ€โš•๏ธ physicianName | string | `"John Smith, MD"` | | ๐Ÿ†” npi | string | `"1234567890"` | | ๐Ÿ’ฐ paymentAmount | number | `5000` | | ๐Ÿข payerCompany | string | `"Pfizer Inc"` | | ๐Ÿท๏ธ paymentType | string | `"General"` | | ๐Ÿ’Š drugOrDevice | string | `"Lipitor"` | | ๐Ÿ“ natureOfPayment | string | `"Consulting Fee"` | | ๐Ÿ“… paymentDate | string | `"2025-06-15"` | | ๐Ÿฅ teachingHospital | string | null | null | | ๐Ÿ”— url | string | `"https://openpaymentsdata.cms.gov/..."` | | ๐Ÿ•’ scrapedAt | ISO 8601 | `"2026-04-16T00:00:00.000Z"` | #### ๐Ÿ“ฆ Sample records
๐Ÿ’ฐ General payment to physician ```json { "physicianName": "John Smith, MD", "npi": "1234567890", "paymentAmount": 5000, "payerCompany": "Pfizer Inc", "paymentType": "General", "drugOrDevice": "Lipitor", "natureOfPayment": "Consulting Fee", "paymentDate": "2025-06-15", "teachingHospital": null, "url": "https://openpaymentsdata.cms.gov/payment/12345", "scrapedAt": "2026-04-16T00:00:00.000Z" } ```
๐Ÿ”ฌ Research payment ```json { "physicianName": "Jane Doe, PhD", "npi": "9876543210", "paymentAmount": 125000, "payerCompany": "Johnson & Johnson", "paymentType": "Research", "drugOrDevice": "Medical Device X", "natureOfPayment": "Research Grant", "paymentDate": "2025-03-01", "teachingHospital": "Johns Hopkins Hospital", "url": "https://openpaymentsdata.cms.gov/payment/67890", "scrapedAt": "2026-04-16T00:00:00.000Z" } ```
๐Ÿฝ๏ธ Small food/beverage payment ```json { "physicianName": "Alex Chen, MD", "npi": "5555555555", "paymentAmount": 25, "payerCompany": "AbbVie", "paymentType": "General", "drugOrDevice": "Humira", "natureOfPayment": "Food and Beverage", "paymentDate": "2025-09-10", "teachingHospital": null, "url": "https://openpaymentsdata.cms.gov/payment/11111", "scrapedAt": "2026-04-16T00:00:00.000Z" } ```
*** ### โœจ Why choose this Actor | | Capability | |---|---| | ๐Ÿ’Š | **Official CMS data.** Sunshine Act payment records. | | ๐Ÿ” | **Provider and company search.** Both directions of the payment relationship. | | ๐Ÿ’ฐ | **Full payment details.** Amount, type, nature, drug/device per record. | | ๐Ÿฅ | **Teaching hospital data.** Hospital payments when applicable. | | โšก | **Scalable.** Single lookups to full company payment sweeps. | | ๐Ÿšซ | **No authentication.** Public transparency data. | *** ### ๐Ÿ“ˆ How it compares to alternatives | Approach | Cost | Coverage | Refresh | Filters | Setup | |---|---|---|---|---|---| | **โญ OpenPayments Scraper** *(this Actor)* | $5 free credit, then pay-per-use | Full database | **Live per run** | provider, company, type, country | โšก 2 min | | CMS OpenPayments website | Free | One at a time | Manual | Basic UI | ๐Ÿ•’ Hours | | CMS bulk download | Free | Full | Annual | None | โณ Hours of parsing | | Paid healthcare data | $500-5,000/month | Multi-source | Varies | Many | ๐Ÿข Weeks | *** ### ๐Ÿš€ 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 OpenPayments Scraper page. 3. ๐ŸŽฏ **Set input.** Paste a search URL or configure filters. 4. ๐Ÿš€ **Run it.** Click **Start**. 5. ๐Ÿ“ฅ **Download.** Grab results in the **Dataset** tab. > โฑ๏ธ Total time: **3-5 minutes.** No coding required. *** ### ๐Ÿ’ผ Business use cases
#### โš–๏ธ Compliance & Transparency - Audit physician-industry relationships - Monitor Sunshine Act compliance - Track conflict-of-interest disclosures - Build compliance reporting databases #### ๐Ÿ“Š Research & Analytics - Analyze pharmaceutical spending patterns - Study payment distribution by specialty - Track industry spending trends over time - Build research datasets for publication
#### ๐Ÿ’Š Pharmaceutical Teams - Monitor competitor spending patterns - Track speaker program activity - Analyze research payment distribution - Benchmark industry payment norms #### ๐Ÿ“ฐ Journalism & Advocacy - Investigate physician-industry payments - Track high-value payment recipients - Build transparency reporting tools - Monitor teaching hospital payments
*** *** ### ๐ŸŒŸ 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%20OpenPayments%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%20OpenPayments%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%20OpenPayments%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%20OpenPayments%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 OpenPayments Scraper - ๐ŸŸข **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. ### ๐Ÿ”Œ Integrate with any app - [**Make**](https://docs.apify.com/platform/integrations/make) - Automate workflows - [**Zapier**](https://docs.apify.com/platform/integrations/zapier) - Connect 5,000+ apps - [**Slack**](https://docs.apify.com/platform/integrations/slack) - Get notifications - [**Airbyte**](https://docs.apify.com/platform/integrations/airbyte) - Data pipelines - [**GitHub**](https://docs.apify.com/platform/integrations/github) - Trigger from commits - [**Google Drive**](https://docs.apify.com/platform/integrations/drive) - Export to Sheets *** ### ๐Ÿ”— Recommended Actors - [**๐Ÿฅ NPI/NPPES Scraper**](https://apify.com/parseforge/npi-nppes-scraper) - Provider registry - [**๐Ÿฅ ClinicalTrials.gov Scraper**](https://apify.com/parseforge/clinicaltrials-scraper) - Clinical trials - [**๐Ÿฉบ RateMDs Scraper**](https://apify.com/parseforge/ratemds-scraper) - Doctor ratings - [**๐Ÿฆ FDIC Bank Scraper**](https://apify.com/parseforge/fdic-bank-scraper) - Bank data - [**๐Ÿ“Š FRED Scraper**](https://apify.com/parseforge/fred-scraper) - Economic data > ๐Ÿ’ก **Pro Tip:** browse the complete [ParseForge collection](https://apify.com/parseforge) for more healthcare and regulatory 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 or the U.S. Department of Health and Human Services. All trademarks mentioned are the property of their respective owners. Only publicly available Sunshine Act data is collected. # Actor input Schema ## `startUrl` (type: `string`): Direct API URL to scrape. Cannot be used together with filter parameters. Leave empty to use filters instead. ## `searchType` (type: `string`): Select the type of search to perform. Only one search type can be selected at a time. The corresponding filter section will be used. ## `maxItems` (type: `integer`): Free users: Limited to 100. Paid users: Optional, max 1,000,000 ## `individualProviderCountry` (type: `string`): Filter by country name. Only used when searchType is 'individualProvider'. ## `individualProviderFirstName` (type: `string`): Filter by provider first name. Only used when searchType is 'individualProvider'. ## `individualProviderLastName` (type: `string`): Filter by provider last name. Only used when searchType is 'individualProvider'. ## `individualProviderCity` (type: `string`): Filter by city name. Only used when searchType is 'individualProvider'. ## `individualProviderZip` (type: `string`): Filter by zip/postal code. Only used when searchType is 'individualProvider'. ## `individualProviderType` (type: `string`): Matches the Open Payments Type filter (e.g., 'Covered Recipient Physician'). Only used when searchType is 'individualProvider'. ## `individualProviderNpi` (type: `string`): Filter by National Provider Identifier. Only used when searchType is 'individualProvider'. ## `teachingHospitalName` (type: `string`): Filter by hospital name. Only used when searchType is 'teachingHospital'. ## `teachingHospitalCity` (type: `string`): Filter by hospital city. Only used when searchType is 'teachingHospital'. ## `teachingHospitalZip` (type: `string`): Filter by hospital zip/postal code. Only used when searchType is 'teachingHospital'. ## `companyName` (type: `string`): Filter by company name. Only used when searchType is 'company'. ## `companyCountry` (type: `string`): Filter by country name. Only used when searchType is 'company'. ## Actor input object example ```json { "startUrl": "https://openpaymentsdata.cms.gov/search?searchType=Provider&Country=UNITED+STATES", "maxItems": 10 } ``` # Actor output Schema ## `individualProviders` (type: `string`): Complete dataset with individual provider payment records including profile information, payment summaries, and entity details ## `hospitals` (type: `string`): Complete dataset with teaching hospital payment records including hospital information, payment summaries, and entity details ## `companies` (type: `string`): Complete dataset with company payment records including company information, payment summaries, and entity details ## `allData` (type: `string`): Complete dataset with all payment records regardless of entity type # 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 = { "startUrl": "https://openpaymentsdata.cms.gov/search?searchType=Provider&Country=UNITED+STATES", "maxItems": 10 }; // Run the Actor and wait for it to finish const run = await client.actor("parseforge/openpayments-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 = { "startUrl": "https://openpaymentsdata.cms.gov/search?searchType=Provider&Country=UNITED+STATES", "maxItems": 10, } # Run the Actor and wait for it to finish run = client.actor("parseforge/openpayments-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 '{ "startUrl": "https://openpaymentsdata.cms.gov/search?searchType=Provider&Country=UNITED+STATES", "maxItems": 10 }' | apify call parseforge/openpayments-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=parseforge/openpayments-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OpenPayments Scraper", "description": "Automate healthcare payment data collection from the CMS Open Payments database. Extract detailed financial relationships between providers and medical companies including research payments, general payments, and ownership interests. Ideal for researchers, compliance teams, and transparency work.", "version": "1.0", "x-build-id": "f9WvJ3Yrzqh3FvuNR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~openpayments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-openpayments-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~openpayments-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-openpayments-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~openpayments-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-openpayments-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 (Alternative)", "type": "string", "description": "Direct API URL to scrape. Cannot be used together with filter parameters. Leave empty to use filters instead." }, "searchType": { "title": "Search Type", "enum": [ "individualProvider", "teachingHospital", "company" ], "type": "string", "description": "Select the type of search to perform. Only one search type can be selected at a time. The corresponding filter section will be used." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 100. Paid users: Optional, max 1,000,000" }, "individualProviderCountry": { "title": "Country", "enum": [ "", "UNITED STATES", "AUSTRALIA", "BAHRAIN", "BERMUDA", "BRAZIL", "CAMEROON", "CANADA", "CHINA", "EGYPT", "FRANCE", "GABON", "GERMANY", "GREAT BRITAIN (UK)", "GUATEMALA", "INDIA", "IRELAND", "ISRAEL", "ITALY", "JAPAN", "KOREA (REPUBLIC OF)", "LEBANON", "MADAGASCAR", "MEXICO", "NETHERLANDS ANTILLES", "NEW ZEALAND", "PAKISTAN", "PAPUA NEW GUINEA", "PHILIPPINES", "SAUDI ARABIA", "SPAIN", "SWITZERLAND", "TRINIDAD AND TOBAGO", "TURKEY", "UGANDA", "UNITED ARAB EMIRATES", "UNITED STATES MINOR OUTLYING ISLANDS" ], "type": "string", "description": "Filter by country name. Only used when searchType is 'individualProvider'." }, "individualProviderFirstName": { "title": "First Name", "type": "string", "description": "Filter by provider first name. Only used when searchType is 'individualProvider'." }, "individualProviderLastName": { "title": "Last Name", "type": "string", "description": "Filter by provider last name. Only used when searchType is 'individualProvider'." }, "individualProviderCity": { "title": "City", "type": "string", "description": "Filter by city name. Only used when searchType is 'individualProvider'." }, "individualProviderZip": { "title": "Zip/Postal code", "type": "string", "description": "Filter by zip/postal code. Only used when searchType is 'individualProvider'." }, "individualProviderType": { "title": "Provider Type", "enum": [ "", "Covered Recipient Physician", "Covered Recipient Non-Physician Practitioner" ], "type": "string", "description": "Matches the Open Payments Type filter (e.g., 'Covered Recipient Physician'). Only used when searchType is 'individualProvider'." }, "individualProviderNpi": { "title": "NPI", "type": "string", "description": "Filter by National Provider Identifier. Only used when searchType is 'individualProvider'." }, "teachingHospitalName": { "title": "Hospital Name", "type": "string", "description": "Filter by hospital name. Only used when searchType is 'teachingHospital'." }, "teachingHospitalCity": { "title": "City", "type": "string", "description": "Filter by hospital city. Only used when searchType is 'teachingHospital'." }, "teachingHospitalZip": { "title": "Zip code", "type": "string", "description": "Filter by hospital zip/postal code. Only used when searchType is 'teachingHospital'." }, "companyName": { "title": "Company Name", "type": "string", "description": "Filter by company name. Only used when searchType is 'company'." }, "companyCountry": { "title": "Country", "enum": [ "", "United States", "Australia", "Bahrain", "Bermuda", "Brazil", "Cameroon", "Canada", "China", "Egypt", "France", "Gabon", "Germany", "Great Britain (UK)", "Guatemala", "India", "Ireland", "Israel", "Italy", "Japan", "Korea (Republic of)", "Lebanon", "Madagascar", "Mexico", "Netherlands Antilles", "New Zealand", "Pakistan", "Papua New Guinea", "Philippines", "Saudi Arabia", "Spain", "Switzerland", "Trinidad and Tobago", "Turkey", "Uganda", "United Arab Emirates", "United States Minor Outlying Islands" ], "type": "string", "description": "Filter by country name. Only used when searchType is 'company'." } } }, "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 } } } } } } } } } } ```