{ "openapi": "3.0.1", "info": { "title": "CMS Home Health Agencies Scraper - Quality & Provider API", "description": "Search the official CMS Care Compare home-health agency snapshot by CCN, name, location, ownership, offered services, certification date, quality stars, and supported measures. Returns source-linked provider, service, suppression, and quality evidence.", "version": "0.1", "x-build-id": "dauljCe2Gh8CNN9Su" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pink_comic~cms-home-health-agencies-quality-provider-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pink_comic-cms-home-health-agencies-quality-provider-scraper", "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-home-health-agencies-quality-provider-scraper/runs": { "post": { "operationId": "runs-sync-pink_comic-cms-home-health-agencies-quality-provider-scraper", "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-home-health-agencies-quality-provider-scraper/run-sync": { "post": { "operationId": "run-sync-pink_comic-cms-home-health-agencies-quality-provider-scraper", "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-9A-Za-z]{6}$", "type": "string", "description": "Exact six-character CMS Certification Number. Empty input uses 027001.", "default": "027001" }, "query": { "title": "Provider Name Keyword", "type": "string", "description": "Case-insensitive provider-name keyword. Clear the default CCN when using this field." }, "state": { "title": "State", "pattern": "^$|^[A-Za-z]{2}$", "type": "string", "description": "Exact two-letter state code." }, "city": { "title": "City Keyword", "type": "string", "description": "Case-insensitive city keyword." }, "zipCode": { "title": "ZIP Code", "pattern": "^$|^[0-9]{5}$", "type": "string", "description": "Exact five-digit ZIP code." }, "ownership": { "title": "Ownership Keyword", "type": "string", "description": "Case-insensitive match against CMS Type of Ownership, such as PROPRIETARY or NON-PROFIT." }, "servicesOffered": { "title": "Required Offered Services", "type": "array", "description": "Require every selected CMS service indicator to equal Yes.", "items": { "type": "string", "enum": [ "nursing", "physical_therapy", "occupational_therapy", "speech_pathology", "medical_social", "home_health_aide" ], "enumTitles": [ "Nursing care", "Physical therapy", "Occupational therapy", "Speech pathology", "Medical social services", "Home health aide" ] }, "default": [] }, "certificationDateFrom": { "title": "Certification Date From", "type": "string", "description": "Local filter, YYYY-MM-DD." }, "certificationDateTo": { "title": "Certification Date To", "type": "string", "description": "Local filter, YYYY-MM-DD." }, "minQualityStarRating": { "title": "Minimum Quality Star Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "0-5 numeric filter. Suppressed/missing ratings cannot satisfy a positive minimum.", "default": 0 }, "measure": { "title": "Selected Quality Measure", "enum": [ "", "timely_care", "walking_improved", "bathing_improved", "breathing_improved", "discharge_function", "dtc", "ppr", "pph" ], "type": "string", "description": "Optional supported source measure to return/filter/sort.", "default": "" }, "minMeasureValue": { "title": "Minimum Selected Measure Value", "type": "number", "description": "Local numeric filter; requires a selected measure.", "default": 0 }, "includeSuppressed": { "title": "Include Suppressed Selected Measures", "type": "boolean", "description": "Include rows whose selected measure is missing/suppressed unless a numeric minimum is set. Footnotes remain explicit.", "default": false }, "sortBy": { "title": "Sort By", "enum": [ "providerName", "qualityStarRating", "certificationDate", "measureValue" ], "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": "" }, "maxCandidates": { "title": "Maximum Source Candidates", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Bound on source rows retrieved before local date/rating/measure filters and sorting.", "default": 1000 }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Total output cap. Each item costs $0.002.", "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 } } } } } } } } } }