{ "openapi": "3.0.1", "info": { "title": "CMS Open Payments API — Physician Roll-up (Sunshine Act)", "description": "CMS Open Payments (Sunshine Act) API: look up physician or manufacturer general payments by name, NPI or manufacturer, rolled up per physician × manufacturer — total USD, payment count, date range and payment-type mix. Pharma-compliance ready. Keyless, official CMS.", "version": "1.0", "x-build-id": "VIPbYOXZVOZKWGe2l" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malonestar~cms-open-payments/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malonestar-cms-open-payments", "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/malonestar~cms-open-payments/runs": { "post": { "operationId": "runs-sync-malonestar-cms-open-payments", "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/malonestar~cms-open-payments/run-sync": { "post": { "operationId": "run-sync-malonestar-cms-open-payments", "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": { "lastName": { "title": "Physician last name", "type": "string", "description": "Covered-recipient (physician) last name to search for. Case-insensitive substring match. Combine with firstName to narrow. Leave blank to search by NPI or manufacturer only." }, "firstName": { "title": "Physician first name", "type": "string", "description": "Covered-recipient (physician) first name. Case-insensitive substring match. Best used together with lastName." }, "npi": { "title": "Physician NPI", "type": "string", "description": "Exact 10-digit National Provider Identifier of the physician. The most precise way to look up one physician's payments." }, "profileId": { "title": "Covered recipient profile ID", "type": "string", "description": "Exact CMS Open Payments covered-recipient profile ID, if you already have it (an alternative precise physician key to NPI)." }, "manufacturer": { "title": "Manufacturer / GPO name", "type": "string", "description": "Name (or part of the name) of the drug/device manufacturer or GPO making the payment. Case-insensitive substring match. Use alone to profile a manufacturer, or with a physician filter to narrow to one relationship." }, "programYear": { "title": "Program year", "type": "string", "description": "Reporting year to query, e.g. 2024. Leave blank to automatically use the most recent General Payments dataset published by CMS." }, "includeSpecialty": { "title": "Enrich physician specialty via NPPES", "type": "boolean", "description": "When on, look up each physician's specialty from the NPPES NPI registry when the payment record lacks one. Best-effort; never fails the run.", "default": false }, "maxResults": { "title": "Max payment rows to pull before roll-up", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Upper bound on raw payment rows fetched (in pages of 500) before aggregating. NOTE: CMS paginates via SQL OFFSET, which slows sharply past ~2000 rows; a time budget stops very deep pulls and returns partial results. Narrow the filter (add firstName/NPI/manufacturer) for complete deep results.", "default": 2000 } } }, "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 } } } } } } } } } }