{ "openapi": "3.0.1", "info": { "title": "CMS Hospice Scraper API - Care Compare Quality & Ratings", "description": "Search CMS Hospice Provider Data by CCN, facility, geography, measure, score/footnote presence, and measurement period. Returns source-linked measure-level Care Compare evidence.", "version": "0.1", "x-build-id": "84ulbjiIjwzP8C4FC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pink_comic~cms-hospice-quality-care-compare/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pink_comic-cms-hospice-quality-care-compare", "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-hospice-quality-care-compare/runs": { "post": { "operationId": "runs-sync-pink_comic-cms-hospice-quality-care-compare", "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-hospice-quality-care-compare/run-sync": { "post": { "operationId": "run-sync-pink_comic-cms-hospice-quality-care-compare", "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. Clear when using broad search fields.", "default": "001500" }, "query": { "title": "Facility Keyword", "type": "string", "description": "Case-insensitive hospice/facility name keyword." }, "state": { "title": "State", "pattern": "^$|^[A-Za-z]{2}$", "type": "string", "description": "Exact two-letter state code." }, "zipCode": { "title": "ZIP Code", "pattern": "^$|^[0-9]{5}$", "type": "string", "description": "Exact five-digit ZIP code." }, "county": { "title": "County Keyword", "type": "string", "description": "Case-insensitive county/parish keyword." }, "measureCode": { "title": "Measure Code", "type": "string", "description": "Exact CMS measure code, such as H_001_01_OBSERVED." }, "measureName": { "title": "Measure Name Keyword", "type": "string", "description": "Case-insensitive measure-name keyword." }, "scorePresence": { "title": "Score Presence", "enum": [ "", "ANY", "PRESENT", "MISSING" ], "type": "string", "description": "Filter source score text presence without converting values.", "default": "" }, "footnotePresence": { "title": "Footnote Presence", "enum": [ "", "ANY", "PRESENT", "MISSING" ], "type": "string", "description": "Filter source footnote presence.", "default": "" }, "measurementFrom": { "title": "Measurement Period From", "pattern": "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Require period start on/after YYYY-MM-DD." }, "measurementTo": { "title": "Measurement Period To", "pattern": "^$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Require period end on/before YYYY-MM-DD." }, "sortBy": { "title": "Sort By", "enum": [ "sourceOrder", "measureCode", "measureName", "facilityName", "score", "measureDateRange" ], "type": "string", "description": "Local deterministic sorting.", "default": "sourceOrder" }, "sortDirection": { "title": "Sort Direction", "enum": [ "asc", "desc" ], "type": "string", "description": "Ascending or descending.", "default": "asc" }, "maxCandidates": { "title": "Maximum Source Candidates", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Bounded source rows checked before local keyword, presence, date, and sorting filters.", "default": 100 }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Total paid output cap; each item costs $0.002.", "default": 5 } } }, "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 } } } } } } } } } }