{ "openapi": "3.0.1", "info": { "title": "CMS Open Payments Scraper", "description": "Query the official CMS Open Payments (Sunshine Act) API for general, research, and ownership payments to physicians and teaching hospitals. Filter by state, NPI, manufacturer, nature, and amount. No login. Free.", "version": "0.1", "x-build-id": "SkIhw278cMduqnZ3b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thetatech-data~cms-open-payments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thetatech-data-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/thetatech-data~cms-open-payments-scraper/runs": { "post": { "operationId": "runs-sync-thetatech-data-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/thetatech-data~cms-open-payments-scraper/run-sync": { "post": { "operationId": "run-sync-thetatech-data-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": { "paymentType": { "title": "Payment type", "enum": [ "general", "research", "ownership" ], "type": "string", "description": "Which Open Payments dataset to query.", "default": "general" }, "year": { "title": "Program year", "minimum": 2019, "maximum": 2025, "type": "integer", "description": "Open Payments program year. Supported: 2019–2025.", "default": 2024 }, "recipientState": { "title": "Recipient state (USPS)", "minLength": 2, "maxLength": 2, "type": "string", "description": "Two-letter US state code for the covered recipient (e.g. RI, MA, CA)." }, "recipientCity": { "title": "Recipient city", "type": "string", "description": "City of the covered recipient's primary business address (exact match, case-insensitive)." }, "recipientNpi": { "title": "Recipient NPI", "type": "string", "description": "National Provider Identifier of the covered recipient (exact match)." }, "recipientLastName": { "title": "Recipient last name", "type": "string", "description": "Last name of the covered recipient (exact match)." }, "manufacturerName": { "title": "Manufacturer / GPO name contains", "type": "string", "description": "Substring match on the manufacturer or GPO that made the payment (e.g. Janssen)." }, "natureOfPayment": { "title": "Nature of payment", "type": "string", "description": "Exact nature of payment / transfer of value (e.g. Food and Beverage, Consulting Fee, Travel and Lodging, Royalty or License)." }, "minAmount": { "title": "Minimum payment amount (USD)", "type": "number", "description": "Only include payments with total USD amount greater than or equal to this value. Applied client-side after the CMS API returns rows (CMS stores amounts as text)." }, "maxAmount": { "title": "Maximum payment amount (USD)", "type": "number", "description": "Only include payments with total USD amount less than or equal to this value. Applied client-side after the CMS API returns rows (CMS stores amounts as text)." }, "maxItems": { "title": "Maximum records", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many records. Hard cap 50,000 per run.", "default": 1000 }, "pageSize": { "title": "API page size", "minimum": 1, "maximum": 500, "type": "integer", "description": "Rows requested per CMS API call (1–500).", "default": 100 }, "delayMs": { "title": "Delay between pages (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Polite delay between CMS API page requests.", "default": 250 } } }, "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 } } } } } } } } } }