{ "openapi": "3.0.1", "info": { "title": "CMS Open Payments Lookup + NPI Enrichment (Sunshine Act)", "description": "Look up CMS Open Payments (Sunshine Act) records with optional NPI enrichment (taxonomy code only). Annual CMS data — use as lookup/audit, not a daily monitor.", "version": "0.1", "x-build-id": "NJuwvsoeuJvaXW5el" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sovereign_workspace~cms-open-payments-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sovereign_workspace-cms-open-payments-monitor", "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/sovereign_workspace~cms-open-payments-monitor/runs": { "post": { "operationId": "runs-sync-sovereign_workspace-cms-open-payments-monitor", "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/sovereign_workspace~cms-open-payments-monitor/run-sync": { "post": { "operationId": "run-sync-sovereign_workspace-cms-open-payments-monitor", "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": { "profile": { "title": "Operator profile", "enum": [ "standard", "smoke" ], "type": "string", "description": "Named config preset applied at start. Any field you set explicitly below overrides the preset." }, "dataset": { "title": "Payment type", "enum": [ "general", "research" ], "type": "string", "description": "Which Open Payments dataset to search: general (non-research) payments or research payments.", "default": "general" }, "program_year": { "title": "Program year", "minimum": 2013, "type": "integer", "description": "Open Payments program year (the year the payment was made). Leave empty for the latest published year. CMS publishes each year's data by June 30 of the following year and refreshes it in January." }, "manufacturer": { "title": "Manufacturer / GPO name", "type": "string", "description": "Only payments made by a manufacturer or GPO whose name contains this text (case-insensitive, e.g. pfizer, medtronic)." }, "npis": { "title": "Recipient NPIs (10-digit)", "type": "array", "description": "Only payments to these physicians or practitioners (up to 200 NPIs), e.g. your KOL list or an audit roster.", "items": { "type": "string" } }, "state": { "title": "Recipient state (2-letter)", "type": "string", "description": "Only payments to recipients in this US state (e.g. CA, TX)." }, "specialty": { "title": "Recipient specialty", "type": "string", "description": "Only payments to recipients whose primary specialty contains this text (e.g. Cardiovascular, Orthopaedic, Dermatology)." }, "min_amount": { "title": "Minimum amount (USD)", "minimum": 0, "type": "number", "description": "Skip payments below this amount (e.g. 1000 to leave out meals). You are only charged for payments at or above it." }, "enrich_npi": { "title": "Join NPPES (current taxonomy, address, phone)", "type": "boolean", "description": "Add each recipient's current NPPES registry taxonomy, practice address and phone. If an NPI isn't found, those fields are left empty; the payment is still returned.", "default": true }, "limit": { "title": "Max payments", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of payment records to return per run (1-5000).", "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 }, "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 } } } } } } } } } }