{ "openapi": "3.0.1", "info": { "title": "US Hospitals Scraper - Ratings, Ownership & Quality", "description": "Scrape US Medicare-certified hospitals with CMS facility ID, address, phone, hospital type, ownership, emergency services, overall 5-star rating, mortality/safety/readmission measures and EHR status. Filter by state, city, ZIP, type, ownership and rating. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "sWYOv0ueJzpmai1bh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~cms-hospitals-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-cms-hospitals-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/scrapers_lat~cms-hospitals-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-cms-hospitals-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/scrapers_lat~cms-hospitals-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-cms-hospitals-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": { "states": { "title": "States", "type": "array", "description": "Filter by 2-letter US state code, for example CA, TX, NY. One run can scan several.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Optional. Filter by city, for example LOS ANGELES, HOUSTON.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Optional. Filter by 5-digit ZIP code.", "items": { "type": "string" } }, "counties": { "title": "Counties", "type": "array", "description": "Optional. Filter by county / parish name, for example LOS ANGELES, HARRIS.", "items": { "type": "string" } }, "nameContains": { "title": "Hospital name contains", "type": "string", "description": "Optional. Keep only hospitals whose name contains this text." }, "hospitalTypes": { "title": "Hospital types", "type": "array", "description": "Optional. Filter by hospital type.", "items": { "type": "string", "enum": [ "Acute Care Hospitals", "Critical Access Hospitals", "Childrens", "Psychiatric", "Rural Emergency Hospital", "Acute Care - Veterans Administration", "Acute Care - Department of Defense" ] } }, "ownershipTypes": { "title": "Ownership types", "type": "array", "description": "Optional. Filter by ownership type.", "items": { "type": "string", "enum": [ "Voluntary non-profit - Private", "Voluntary non-profit - Church", "Voluntary non-profit - Other", "Proprietary", "Physician", "Government - Hospital District or Authority", "Government - Local", "Government - State", "Government - Federal", "Department of Defense", "Veterans Health Administration", "Tribal" ] } }, "emergencyServices": { "title": "Emergency services", "type": "boolean", "description": "Optional. Set on to keep only hospitals WITH emergency services, off to keep only those without. Leave unset to include both." }, "birthingFriendlyOnly": { "title": "Only Birthing Friendly hospitals", "type": "boolean", "description": "When on, keep only hospitals that meet the CMS Birthing Friendly designation.", "default": false }, "minOverallRating": { "title": "Minimum overall star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Optional. Keep only hospitals with an overall 5-star rating at or above this value (1-5)." }, "maxOverallRating": { "title": "Maximum overall star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Optional. Keep only hospitals with an overall 5-star rating at or below this value (1-5)." }, "facilityIds": { "title": "Facility IDs (CCN)", "type": "array", "description": "Optional. Look up specific hospitals by their CMS facility ID / CCN.", "items": { "type": "string" } }, "includeEhr": { "title": "Include EHR / Promoting Interoperability status", "type": "boolean", "description": "When on (default), attach each hospital's certified EHR ID and Promoting Interoperability (meaningful use) status.", "default": true }, "maxHospitals": { "title": "Max Hospitals To Scrape", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of hospitals to collect." } } }, "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 } } } } } } } } } }