{ "openapi": "3.0.1", "info": { "title": "CMS Open Payments Scraper - Pharma & Device Payments", "description": "Scrape CMS Open Payments (Sunshine Act) general, research, and ownership payments from pharmaceutical and medical device manufacturers to physicians and teaching hospitals.", "version": "0.1", "x-build-id": "xfaD2eBg01i1cswmc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/groundplanes~cms-open-payments-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-groundplanes-cms-open-payments-search", "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/groundplanes~cms-open-payments-search/runs": { "post": { "operationId": "runs-sync-groundplanes-cms-open-payments-search", "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/groundplanes~cms-open-payments-search/run-sync": { "post": { "operationId": "run-sync-groundplanes-cms-open-payments-search", "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": { "manufacturerNames": { "title": "Manufacturer / GPO Names (Contains Match)", "type": "array", "description": "Case-insensitive substring match against applicable_manufacturer_or_applicable_gpo_making_payment_name (e.g. [\"Stryker\"], [\"Medtronic\", \"Pfizer\"]). Leave empty to include all manufacturers.", "items": { "type": "string" }, "default": [ "Stryker" ] }, "maxItems": { "title": "Max Items", "minimum": 1, "type": "integer", "description": "Maximum number of payment records to return, sorted newest first by paymentDate.", "default": 200 }, "minAmountUsd": { "title": "Minimum Payment Amount (USD)", "minimum": 0, "type": "number", "description": "Minimum payment or investment value in USD. Set to 0 to return all matching payments.", "default": 0 }, "natureOfPayment": { "title": "Nature of Payment Filter", "type": "array", "description": "Optional substring filters on nature_of_payment_or_transfer_of_value (e.g. [\"Consulting Fee\", \"Royalty or License\", \"Compensation for services\"]). Leave empty for all payment natures.", "items": { "type": "string" }, "default": [] }, "paymentType": { "title": "Payment Dataset Type", "enum": [ "GENERAL", "RESEARCH", "OWNERSHIP" ], "type": "string", "description": "CMS Open Payments dataset type: GENERAL (general payments such as consulting, royalties, food/beverage, travel), RESEARCH (clinical trial and research grants), or OWNERSHIP (physician ownership/investment interests).", "default": "GENERAL" }, "programYear": { "title": "Program Year", "minimum": 2017, "maximum": 2030, "type": "integer", "description": "CMS Open Payments reporting program year (e.g. 2025, 2024, 2023). Leave blank or omit to use the latest available year, resolved dynamically from the CMS DKAN metastore at runtime. The dataset UUID is also resolved dynamically from the metastore." }, "recipientStates": { "title": "Recipient States (2-letter codes)", "type": "array", "description": "Two-letter US state or territory postal codes for the recipient physician or teaching hospital (e.g. [\"AZ\"] or [\"AZ\", \"CA\"]). Leave empty for all states.", "items": { "type": "string" }, "default": [ "AZ" ] } } }, "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 } } } } } } } } } }