{ "openapi": "3.0.1", "info": { "title": "CMS Open Payments Scraper (Physician Payments)", "description": "Scrape US CMS Open Payments records of industry payments to physicians and teaching hospitals. Get recipient name, NPI, specialty, paying company, amount, nature of payment, drug or device and program year. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "lkQVBlun600XXLIxJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~cms-open-payments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-cms-open-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/scrapers_lat~cms-open-payments-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-cms-open-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/scrapers_lat~cms-open-payments-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-cms-open-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": { "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of payment records to collect across all pages. Optional. Add filters below to narrow very large result sets." }, "paymentType": { "title": "Payment Type", "enum": [ "general", "research", "ownership" ], "type": "string", "description": "Which Open Payments dataset to search. General covers everyday transfers of value (consulting, food, travel, gifts). Research covers payments tied to research studies. Ownership covers physician ownership and investment interests.", "default": "general" }, "programYear": { "title": "Program Year", "enum": [ "2025", "2024", "2023", "2022", "2021", "2020", "2019" ], "type": "string", "description": "The calendar year the payments were reported for.", "default": "2024" }, "npi": { "title": "NPI Number", "type": "string", "description": "Filter to a single recipient by their 10-digit National Provider Identifier (NPI). Exact match." }, "physicianFirstName": { "title": "Physician First Name", "type": "string", "description": "Filter by recipient first name. Exact match, case-insensitive." }, "physicianLastName": { "title": "Physician Last Name", "type": "string", "description": "Filter by recipient last name. Exact match, case-insensitive." }, "companyName": { "title": "Paying Company Name", "type": "string", "description": "Filter by the paying company (drug or device manufacturer or group purchasing organization). Partial match, for example Pfizer, Medtronic, Stryker." }, "state": { "title": "Recipient State", "enum": [ "", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI" ], "type": "string", "description": "Two-letter US state or territory code of the recipient, for example CA, NY, TX, PR.", "default": "" }, "natureOfPayment": { "title": "Nature of Payment", "enum": [ "", "Consulting Fee", "Compensation for services other than consulting, including serving as faculty or as a speaker at a venue other than a continuing education program", "Compensation for serving as faculty or as a speaker for a medical education program", "Honoraria", "Food and Beverage", "Travel and Lodging", "Education", "Gift", "Entertainment", "Charitable Contribution", "Grant", "Royalty or License", "Space rental or facility fees (including trade show fees)", "Debt forgiveness", "Long term medical supply or device loan", "Current or prospective ownership or investment interest", "Acquisitions" ], "type": "string", "description": "Filter General payments by the category of the transfer of value. Applies to General payments only.", "default": "" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional. CMS Open Payments is a public, open data service and does not require a proxy. Leave disabled unless you specifically need to route requests through a 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 } } } } } } } } } }