{ "openapi": "3.0.1", "info": { "title": "CMS Open Payments Crawler - Physician Pharma Payment Data", "description": "Crawl physician payment records from the CMS Open Payments database (Sunshine Act). Extract payments from pharma and device companies to physicians. Filter by state, specialty, payer, payment type, year, and minimum amount.", "version": "1.0", "x-build-id": "Z7tVI2a0GNqTrjh7P" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jungle_synthesizer~openpayments-cms-crawler/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jungle_synthesizer-openpayments-cms-crawler", "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/jungle_synthesizer~openpayments-cms-crawler/runs": { "post": { "operationId": "runs-sync-jungle_synthesizer-openpayments-cms-crawler", "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/jungle_synthesizer~openpayments-cms-crawler/run-sync": { "post": { "operationId": "run-sync-jungle_synthesizer-openpayments-cms-crawler", "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", "required": [ "sp_intended_usage", "sp_improvement_suggestions" ], "properties": { "sp_intended_usage": { "title": "What is the intended usage of this data?", "minLength": 1, "type": "string", "description": "Please describe how you plan to use the data extracted by this crawler." }, "sp_improvement_suggestions": { "title": "How can we improve this crawler for you?", "minLength": 1, "type": "string", "description": "Provide any feedback or suggestions for improvements." }, "sp_contact": { "title": "Contact Email", "minLength": 1, "type": "string", "description": "Provide your email address so we can get in touch with you." }, "programYear": { "title": "Program Year", "enum": [ "2024", "2023", "2022", "2021", "2020", "2019", "2018" ], "type": "string", "description": "Filter by program year. Defaults to the most recent available year (2024).", "default": "2024" }, "datasetType": { "title": "Dataset Type", "enum": [ "general", "research", "ownership" ], "type": "string", "description": "Select which Open Payments dataset to query. General Payments covers food, travel, consulting, speaking fees. Research Payments covers research funding. Physician Ownership covers ownership/investment interests.", "default": "general" }, "states": { "title": "Recipient State", "type": "array", "description": "Filter by recipient state. Leave empty for all states.", "items": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "enumTitles": [ "Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "District of Columbia", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming" ] } }, "paymentType": { "title": "Payment Type", "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", "Food and Beverage", "Travel and Lodging", "Education", "Entertainment", "Gift", "Honoraria", "Charitable Contribution", "Royalty or License", "Current or prospective ownership or investment interest", "Space rental or facility fees (payments by a third party)", "Grant" ], "type": "string", "description": "Filter by nature of payment or transfer of value." }, "payerName": { "title": "Payer (Company) Name", "type": "string", "description": "Search by pharmaceutical or medical device company name. Supports partial match." }, "physicianName": { "title": "Physician Name", "type": "string", "description": "Search by physician last name. Supports partial match." }, "physicianSpecialty": { "title": "Physician Specialty", "enum": [ "", "Allopathic & Osteopathic Physicians|Internal Medicine", "Allopathic & Osteopathic Physicians|Family Medicine", "Allopathic & Osteopathic Physicians|Psychiatry & Neurology", "Allopathic & Osteopathic Physicians|Orthopedic Surgery", "Allopathic & Osteopathic Physicians|Anesthesiology", "Allopathic & Osteopathic Physicians|Surgery", "Allopathic & Osteopathic Physicians|Radiology", "Allopathic & Osteopathic Physicians|Emergency Medicine", "Allopathic & Osteopathic Physicians|Obstetrics & Gynecology", "Allopathic & Osteopathic Physicians|Ophthalmology", "Allopathic & Osteopathic Physicians|Dermatology", "Allopathic & Osteopathic Physicians|Urology", "Allopathic & Osteopathic Physicians|Pathology", "Dental Providers|Dentist", "Physician Assistants & Advanced Practice Nursing Providers|Nurse Practitioner" ], "type": "string", "description": "Filter by physician specialty." }, "minPaymentAmount": { "title": "Minimum Payment Amount ($)", "type": "number", "description": "Filter for payments at or above this dollar amount. Applied client-side after fetching records.", "default": 0 }, "maxItems": { "title": "Max Items", "type": "integer", "description": "Maximum number of payment records to return.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies. The CMS Open Payments API is a government service and typically does not require proxies." } } }, "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 } } } } } } } } } }