{ "openapi": "3.0.1", "info": { "title": "Open Payments: Doctor and Pharma Payments Scraper", "description": "Search CMS Open Payments (Sunshine Act): payments from drug and device makers to doctors and teaching hospitals since 2019. Filter by doctor, NPI, state, specialty, company, product and payment type. Totals per doctor, company rankings and specialty medians. Export to CSV or Excel.", "version": "1.0", "x-build-id": "lcl5HpdstBFycQvO7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parselab~cms-open-payments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parselab-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/parselab~cms-open-payments-scraper/runs": { "post": { "operationId": "runs-sync-parselab-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/parselab~cms-open-payments-scraper/run-sync": { "post": { "operationId": "run-sync-parselab-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": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000." }, "mode": { "title": "What to collect", "enum": [ "payments", "physicianTotals", "companyTotals", "teachingHospitals", "specialtyBenchmarks", "stateBenchmarks" ], "type": "string", "description": "Individual payments gives one row per payment. Doctor totals gives one row per doctor and year with all payment types added up and compared with the specialty median. Company totals ranks the drug and device makers. Teaching hospitals, specialty benchmarks and state benchmarks give the matching summaries.", "default": "payments" }, "years": { "title": "Program years", "type": "array", "description": "Years to read, from 2019 to 2025. Leave the prefilled value for the year 2024.", "items": { "type": "string" } }, "lastName": { "title": "Doctor last name", "type": "string", "description": "Exact last name of the doctor, for example Smith. Used in individual payments and doctor totals." }, "firstName": { "title": "Doctor first name", "type": "string", "description": "Exact first name of the doctor." }, "npis": { "title": "NPI numbers", "type": "array", "description": "National Provider Identifier numbers of doctors to look up, for example 1528271848.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Two letter state codes of the doctor's practice, for example NY, CA, TX. For company totals this is the state of the company.", "items": { "type": "string" } }, "specialty": { "title": "Specialty", "type": "string", "description": "Part of the specialty name, for example Cardiology, Orthopaedic or Family Medicine." }, "companies": { "title": "Companies", "type": "array", "description": "Part of the name of the paying company, for example Pfizer, Medtronic or Eli Lilly. Each name is searched on its own.", "items": { "type": "string" } }, "natureOfPayment": { "title": "Nature of payment", "type": "array", "description": "Exact payment type names such as Food and Beverage, Consulting Fee, Travel and Lodging, Royalty or License, Honoraria, Education, Grant or Gift.", "items": { "type": "string" } }, "productName": { "title": "Product name", "type": "string", "description": "Part of the drug or device name linked to the payment, for example Humira or Ozempic." }, "recipientType": { "title": "Recipient type", "enum": [ "all", "physician", "nonPhysician", "teachingHospital" ], "type": "string", "description": "Doctors, other practitioners such as nurse practitioners, or teaching hospitals.", "default": "all" }, "minAmount": { "title": "Minimum amount (USD)", "minimum": 0, "type": "number", "description": "Skip payments or totals below this amount. With individual payments the filter is applied after reading, so large searches take longer." }, "teachingHospitalName": { "title": "Teaching hospital name", "type": "string", "description": "Part of a teaching hospital name, for example Mayo or Johns Hopkins." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }