{ "openapi": "3.0.1", "info": { "title": "Healthgrades Provider Search Scraper", "description": "Search Healthgrades for US doctors by specialty and location and get the full result set back with the practice phone number, GPS coordinates and accepted insurance plans filled in - the fields competing Healthgrades actors leave null.", "version": "0.1", "x-build-id": "SfeOf1UH3oDxGaXBV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~healthgrades-provider-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-healthgrades-provider-search-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/cirkit~healthgrades-provider-search-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-healthgrades-provider-search-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/cirkit~healthgrades-provider-search-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-healthgrades-provider-search-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": { "specialties": { "title": "Specialties", "type": "array", "description": "What to search for, exactly as you would type it into Healthgrades: a specialty (\"Cardiology\", \"Dermatology\"), a condition (\"Fibromyalgia\") or a procedure (\"Colonoscopy\"). Every specialty is searched in every location below, so 3 specialties x 4 cities is 12 searches.", "default": [], "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Where to search. A city and state (\"Austin, TX\"), a ZIP code (\"78701\") or a state name all work. Healthgrades search is always location-scoped, so at least one location is required whenever you set a specialty.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Healthgrades search URLs", "type": "array", "description": "Paste Healthgrades /usearch result URLs straight out of your browser. Any filters already in the URL are kept as the Actor pages through the results, so this is the way to use filters this input schema does not expose.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max providers", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Hard cap on how many providers this run returns, and therefore on what it costs. Duplicates are dropped before this cap applies. Pages are only fetched while there is still room under the cap, so a low number here genuinely costs less.", "default": 100 }, "maxItemsPerSearch": { "title": "Max providers per search", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Optional per-search cap, useful when you want an even spread across many cities instead of letting the first city consume the whole budget. Leave empty for no per-search limit." }, "sort": { "title": "Sort order", "enum": [ "bestmatch", "distance", "ratings" ], "type": "string", "description": "How Healthgrades orders the result set before this Actor reads it.", "default": "bestmatch" }, "acceptingNewPatientsOnly": { "title": "Only providers accepting new patients", "type": "boolean", "description": "Keep only providers Healthgrades marks as accepting new patients. Filtered rows are never charged.", "default": false }, "minRating": { "title": "Minimum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only providers whose patient rating is at least this many stars out of 5. Providers with no ratings yet are excluded when this is set. Filtered rows are never charged." }, "includeBiography": { "title": "Include biography", "type": "boolean", "description": "Include the provider's biography and care philosophy. These come free with the search page - no extra request and no extra charge - but they are long, so switch this off for a tidier CSV.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Healthgrades serves this data to datacenter proxies, which is what the default uses. Switch to residential only if you see a run get blocked.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }