{ "openapi": "3.0.1", "info": { "title": "CMS Dialysis Facility Compare Scraper API - Quality Data", "description": "Search and aggregate official CMS Medicare dialysis facility quality data by CCN, NPI, provider, geography, ownership, chain, modality, ESRD network, and measure. One paid item per facility preserves source measure names, values, IDs, years, provenance, and evidence limits.", "version": "0.1", "x-build-id": "MQwIclOJLgxhA8Vo8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pink_comic~cms-medicare-dialysis-facilities-quality-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pink_comic-cms-medicare-dialysis-facilities-quality-data", "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-dialysis-facilities-quality-data/runs": { "post": { "operationId": "runs-sync-pink_comic-cms-medicare-dialysis-facilities-quality-data", "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-dialysis-facilities-quality-data/run-sync": { "post": { "operationId": "run-sync-pink_comic-cms-medicare-dialysis-facilities-quality-data", "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": { "ccn": { "title": "Exact CCN", "pattern": "^$|^[0-9]{6}$", "type": "string", "description": "Exact six-digit CMS Certification Number.", "default": "012306" }, "npi": { "title": "Exact NPI", "pattern": "^$|^[0-9]{10}$", "type": "string", "description": "Exact ten-digit facility NPI. Clear CCN first." }, "providerName": { "title": "Exact Provider Name", "type": "string", "description": "Exact CMS provider name. Clear CCN first.", "default": "CHILDRENS HOSPITAL OF ALABAMA ESRD" }, "query": { "title": "Provider Name Keyword", "type": "string", "description": "Case-insensitive provider-name keyword for bounded candidate searches." }, "state": { "title": "State", "pattern": "^$|^[A-Za-z]{2}$", "type": "string", "description": "Two-letter state abbreviation." }, "city": { "title": "City", "type": "string", "description": "Exact city, case-insensitive." }, "ownership": { "title": "Ownership Type Contains", "type": "string", "description": "Local case-insensitive ownership filter." }, "chain": { "title": "Chain Contains", "type": "string", "description": "Local case-insensitive chain filter." }, "modality": { "title": "Modality Contains", "type": "string", "description": "Filter hemodialysis/peritoneal-dialysis modality text." }, "network": { "title": "ESRD Network", "type": "string", "description": "Exact CMS ESRD network value, such as 08." }, "measureName": { "title": "Measure Name Contains", "type": "string", "description": "Keep only source measure rows whose name contains this text." }, "measureValue": { "title": "Measure Value Contains", "type": "string", "description": "Keep source measure rows by reported value/label. Suppressed or unavailable is not zero." }, "sortBy": { "title": "Sort By", "enum": [ "providerName", "ccn", "measureCount" ], "type": "string", "description": "Optional sort by filter or result-control setting. See the README for source semantics and examples.", "default": "providerName" }, "sortDirection": { "title": "Sort Direction", "enum": [ "asc", "desc" ], "type": "string", "description": "Optional sort direction filter or result-control setting. See the README for source semantics and examples.", "default": "asc" }, "maxCandidates": { "title": "Maximum Raw Measure Rows Checked", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Bound before aggregation. Exact lookups use at least 2,000 rows to preserve measure evidence.", "default": 2000 }, "maxResults": { "title": "Maximum Facility Items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Total one-per-CCN paid output cap. The one-item default costs at most $0.0021: $0.0001 start plus $0.002 per item.", "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 } } } } } } } } } }