{ "openapi": "3.0.1", "info": { "title": "CMS Open Payments Pro — Sunshine Act + NPI API", "description": "Sunshine Act pharma-to-physician payments enriched with NPI Registry specialty + practice address. Per (physician × manufacturer) intensity signal. Consulting / speaking / meal / travel / research filters. Compliance, plaintiff law, payer audit, medical journalism.", "version": "0.0", "x-build-id": "1Cd7HqJ2527LLwwIL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~cms-open-payments-physician-intelligence-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-cms-open-payments-physician-intelligence-pro", "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/nexgendata~cms-open-payments-physician-intelligence-pro/runs": { "post": { "operationId": "runs-sync-nexgendata-cms-open-payments-physician-intelligence-pro", "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/nexgendata~cms-open-payments-physician-intelligence-pro/run-sync": { "post": { "operationId": "run-sync-nexgendata-cms-open-payments-physician-intelligence-pro", "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": { "physician_name": { "title": "Physician name", "type": "string", "description": "Full name (first + last) or just last name. Used to filter CMS Open Payments records AND to seed the NPI Registry join when no NPI is supplied. Examples: 'John Smith', 'Sanjay Gupta', 'Mehmet Oz'." }, "npi": { "title": "Physician NPI", "type": "string", "description": "10-digit National Provider Identifier. Most precise filter — every payment to that physician in the date window, with NPI Registry primary specialty + practice address joined on the row." }, "manufacturer_name": { "title": "Manufacturer / GPO name", "type": "string", "description": "Substring match on the paying manufacturer or GPO. Combine with physician_name/npi to scope to a specific brand relationship. Examples: 'Pfizer', 'Medtronic', 'Novo Nordisk', 'Genentech'." }, "payment_category": { "title": "Payment category", "enum": [ "consulting", "speaking", "meal", "travel", "research", "any" ], "type": "string", "description": "Buyer-friendly category mapped to CMS 'nature_of_payment'. 'consulting' = consulting fees; 'speaking' = speaker bureau / honoraria / faculty; 'meal' = food and beverage; 'travel' = travel and lodging; 'research' = research payments (clinical trial / preclinical); 'any' = no filter and includes research alongside general payments.", "default": "any" }, "date_from": { "title": "Date from", "type": "string", "description": "Start of the payment-date window, ISO format YYYY-MM-DD. CMS publishes payment dates per program year; the actor sweeps every per-year dataset touched by [date_from, date_to]. Default: one year ago." }, "date_to": { "title": "Date to", "type": "string", "description": "End of the payment-date window, ISO format YYYY-MM-DD. Default: today. Note: CMS Open Payments publishes annually in June; the most recent full program year is typically ~18 months behind real time." }, "max_records": { "title": "Max records", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of joined payment records to return across all years in the window (1-5000). Each record is one CMS Open Payments line item enriched with NPI Registry specialty + practice address. Set to 5000 for a full physician compensation profile across multiple years.", "default": 100 } } }, "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 } } } } } } } } } }