{ "openapi": "3.0.1", "info": { "title": "Healthcare Provider Payments Scraper - NPI & CMS Payments", "description": "NPPES provider profiles matched to real CMS Open Payments industry payments: general, research and ownership/investment interests, across every available program year. Export to CSV, Excel, JSON.", "version": "0.1", "x-build-id": "LW7oTVGTQ6gHo5H5F" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/punkrecordsdata~healthcare-provider-payments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-punkrecordsdata-healthcare-provider-payments-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/punkrecordsdata~healthcare-provider-payments-scraper/runs": { "post": { "operationId": "runs-sync-punkrecordsdata-healthcare-provider-payments-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/punkrecordsdata~healthcare-provider-payments-scraper/run-sync": { "post": { "operationId": "run-sync-punkrecordsdata-healthcare-provider-payments-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": { "providerName": { "title": "Provider name (individual)", "type": "string", "description": "Individual provider's first and last name (e.g. \"John Smith\"). Leave blank if searching by organization name instead." }, "organizationName": { "title": "Organization name", "type": "string", "description": "Organization/facility name to search instead of an individual provider (e.g. \"Mayo Clinic\")." }, "state": { "title": "State (2-letter code)", "type": "string", "description": "Optional. Narrows the NPPES search to a US state (e.g. \"CA\")." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of provider-record rows to deliver. Free users: limited to 10 (preview). Paid users: optional, max 1,000,000." }, "includeGeneralPayments": { "title": "General payments (CMS Open Payments)", "type": "boolean", "description": "Food, travel, consulting, speaking and gift payments from drug/device companies. Billed per payment as general-payment-record.", "default": false }, "maxGeneralPayments": { "title": "Max general payments per provider", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many general-payment records to pull per provider when General payments is on.", "default": 50 }, "includeResearchPayments": { "title": "Research payments (CMS Open Payments)", "type": "boolean", "description": "Payments made in connection with a formal research agreement or protocol. Billed per payment as research-payment-record.", "default": false }, "maxResearchPayments": { "title": "Max research payments per provider", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many research-payment records to pull per provider when Research payments is on.", "default": 50 }, "includeOwnershipInterests": { "title": "Ownership & investment interests (CMS Open Payments)", "type": "boolean", "description": "Ownership or investment interests a physician (or immediate family member) holds in a reporting drug/device company. Billed per interest as ownership-interest-record.", "default": false }, "maxOwnershipInterests": { "title": "Max ownership interests per provider", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many ownership-interest records to pull per provider when Ownership & investment interests is on.", "default": 20 } } }, "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 } } } } } } } } } }