{ "openapi": "3.0.1", "info": { "title": "CMS Medicare Part B Utilization Scraper API - Providers", "description": "Search CMS 2024 Medicare Physician & Other Practitioners provider/service claims aggregates by NPI, specialty, geography, HCPCS, setting, volume, charges, allowed amount, and payment. Returns source-linked market-intelligence evidence with suppression and lag caveats.", "version": "0.1", "x-build-id": "jNDSXIDga36ZjerzG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pink_comic~cms-medicare-part-b-provider-service-utilization/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pink_comic-cms-medicare-part-b-provider-service-utilization", "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/pink_comic~cms-medicare-part-b-provider-service-utilization/runs": { "post": { "operationId": "runs-sync-pink_comic-cms-medicare-part-b-provider-service-utilization", "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/pink_comic~cms-medicare-part-b-provider-service-utilization/run-sync": { "post": { "operationId": "run-sync-pink_comic-cms-medicare-part-b-provider-service-utilization", "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": { "npi": { "title": "Rendering NPI", "pattern": "^$|^[0-9]{10}$", "type": "string", "description": "Exact 10-digit rendering NPI.", "default": "1003000126" }, "providerName": { "title": "Provider name", "type": "string", "description": "Case-insensitive last-name or organization-name keyword, checked locally within the candidate bound.", "default": "" }, "entityCode": { "title": "Entity type", "enum": [ "", "I", "O" ], "type": "string", "description": "CMS rendering-provider entity code.", "default": "" }, "specialty": { "title": "Provider specialty", "type": "string", "description": "Exact CMS provider type/specialty, such as Internal Medicine.", "default": "" }, "state": { "title": "State", "pattern": "^$|^[A-Za-z]{2}$", "type": "string", "description": "Exact two-letter provider state.", "default": "" }, "zipCode": { "title": "ZIP code", "pattern": "^$|^[0-9]{5}$", "type": "string", "description": "Exact five-digit provider ZIP.", "default": "" }, "hcpcsCode": { "title": "HCPCS code", "type": "string", "description": "Exact HCPCS service/drug code.", "default": "" }, "hcpcsDescription": { "title": "HCPCS description keyword", "type": "string", "description": "Case-insensitive service-description keyword checked locally.", "default": "" }, "placeOfService": { "title": "Place of service", "enum": [ "", "F", "O" ], "type": "string", "description": "Facility or non-facility setting reported by CMS.", "default": "" }, "drugIndicator": { "title": "HCPCS drug indicator", "enum": [ "", "Y", "N" ], "type": "string", "description": "Whether CMS identifies the HCPCS row as a drug.", "default": "" }, "minBeneficiaries": { "title": "Minimum beneficiaries", "minimum": 0, "type": "integer", "description": "Local minimum; suppressed blanks do not pass a positive threshold.", "default": 0 }, "minServices": { "title": "Minimum services", "minimum": 0, "type": "number", "description": "Local minimum annual services.", "default": 0 }, "minAverageCharge": { "title": "Minimum average submitted charge", "minimum": 0, "type": "number", "description": "Optional minimum average submitted charge filter or result-control setting. See the README for exact source semantics, bounds, and examples.", "default": 0 }, "maxAverageCharge": { "title": "Maximum average submitted charge", "minimum": 0, "type": "number", "description": "Optional maximum average submitted charge filter or result-control setting. See the README for exact source semantics, bounds, and examples.", "default": 0 }, "minAllowedAmount": { "title": "Minimum average Medicare allowed amount", "minimum": 0, "type": "number", "description": "Optional minimum average medicare allowed amount filter or result-control setting. See the README for exact source semantics, bounds, and examples.", "default": 0 }, "maxAllowedAmount": { "title": "Maximum average Medicare allowed amount", "minimum": 0, "type": "number", "description": "Optional maximum average medicare allowed amount filter or result-control setting. See the README for exact source semantics, bounds, and examples.", "default": 0 }, "minPaymentAmount": { "title": "Minimum average Medicare payment", "minimum": 0, "type": "number", "description": "Optional minimum average medicare payment filter or result-control setting. See the README for exact source semantics, bounds, and examples.", "default": 0 }, "maxPaymentAmount": { "title": "Maximum average Medicare payment", "minimum": 0, "type": "number", "description": "Optional maximum average medicare payment filter or result-control setting. See the README for exact source semantics, bounds, and examples.", "default": 0 }, "sortBy": { "title": "Sort by", "enum": [ "hcpcsCode", "npi", "providerName", "specialty", "beneficiaries", "services", "averageCharge", "allowedAmount", "paymentAmount" ], "type": "string", "description": "Deterministic local sort over bounded candidates.", "default": "hcpcsCode" }, "sortDirection": { "title": "Sort direction", "enum": [ "", "asc", "desc" ], "type": "string", "description": "Optional sort direction filter or result-control setting. See the README for exact source semantics, bounds, and examples.", "default": "" }, "offset": { "title": "Source offset", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Starting CMS row offset.", "default": 0 }, "maxCandidates": { "title": "Maximum source candidates", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard bound on CMS rows retrieved before local filters and sorting.", "default": 1 }, "maxPages": { "title": "Maximum source pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Hard pagination bound; each page is at most 500 rows.", "default": 1 }, "maxResults": { "title": "Maximum paid service rows", "minimum": 1, "maximum": 500, "type": "integer", "description": "Total output rows after filtering/sorting. Default one costs at most $0.0021 including start.", "default": 1 } } }, "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 } } } } } } } } } }