{ "openapi": "3.0.1", "info": { "title": "CMS Open Payments Search", "description": "Search the **CMS Open Payments** database for payments made by pharmaceutical and medical device companies to physicians and teaching hospitals across the United States. Access **15 million+ general payment records** and **750,000+ research payment records** per year, covering 2018 through 2024.", "version": "1.0", "x-build-id": "PaCw6yDlRo0VuRfeK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ryanclinton~cms-open-payments/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ryanclinton-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/ryanclinton~cms-open-payments/runs": { "post": { "operationId": "runs-sync-ryanclinton-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/ryanclinton~cms-open-payments/run-sync": { "post": { "operationId": "run-sync-ryanclinton-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": { "physicianName": { "title": "Physician Last Name", "type": "string", "description": "Filter by physician last name (exact match, case-insensitive). Example: SMITH" }, "physicianFirstName": { "title": "Physician First Name", "type": "string", "description": "Filter by physician first name (exact match). Combine with last name for precise results." }, "physicianNpi": { "title": "Physician NPI", "type": "string", "description": "Filter by National Provider Identifier (10-digit number). Most precise physician lookup." }, "companyName": { "title": "Paying Company Name", "type": "string", "description": "Filter by the pharmaceutical or device company making the payment. Example: Pfizer" }, "state": { "title": "Recipient State", "maxLength": 2, "type": "string", "description": "Two-letter US state code. Example: CA, NY, TX" }, "paymentNature": { "title": "Nature of Payment", "enum": [ "", "Consulting Fee", "Compensation for services other than consulting, including serving as faculty or as a speaker at a venue other than a continuing education program", "Honoraria", "Gift", "Entertainment", "Food and Beverage", "Travel and Lodging", "Education", "Research", "Charitable Contribution", "Royalty or License", "Current or prospective ownership or investment interest", "Compensation for serving as faculty or as a speaker for a non-accredited and noncertified continuing education program", "Compensation for serving as faculty or as a speaker for an accredited or certified continuing education program", "Grant", "Space rental or facility fees (teaching hospital only)" ], "type": "string", "description": "Filter by payment type" }, "minAmount": { "title": "Minimum Payment Amount ($)", "minimum": 0, "type": "number", "description": "Only return payments at or above this dollar amount" }, "maxAmount": { "title": "Maximum Payment Amount ($)", "minimum": 0, "type": "number", "description": "Only return payments at or below this dollar amount" }, "programYear": { "title": "Program Year", "enum": [ "2024", "2023", "2022", "2021", "2020", "2019", "2018" ], "type": "string", "description": "Which reporting year to search. Defaults to latest (2024).", "default": "2024" }, "dataType": { "title": "Payment Data Type", "enum": [ "general", "research", "both" ], "type": "string", "description": "General payments (food, travel, consulting, etc.) or Research payments (clinical trial funding)", "default": "general" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of payment records to return", "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 } } } } } } } } } }