{ "openapi": "3.0.1", "info": { "title": "Healthgrades Scraper - Doctors, NPI, Insurance & Reviews", "description": "Export US doctors from Healthgrades by specialty and city, state or URL: name, specialty, NPI, practice address, phone, rating, review counts, accepted insurers and optional patient reviews. For healthcare marketing, lead lists and reputation analysis.", "version": "0.1", "x-build-id": "u2qDae1ecL6Kdo6vM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~healthgrades-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-healthgrades-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/s-r~healthgrades-scraper/runs": { "post": { "operationId": "runs-sync-s-r-healthgrades-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/s-r~healthgrades-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-healthgrades-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": { "specialty": { "title": "Specialty", "maxLength": 200, "type": "string", "description": "Specialty, provider name or condition, such as Dermatology. Required with location when startUrls is empty." }, "searchQuery": { "title": "Searchquery", "maxLength": 200, "type": "string", "description": "Alias for specialty; specialty takes precedence when both are supplied." }, "location": { "title": "Location", "maxLength": 200, "type": "string", "description": "US city and state (Chicago, IL), five-digit ZIP code, state abbreviation or full state name. Required for a text search." }, "startUrls": { "title": "Starturls", "type": "array", "description": "Up to 20 Healthgrades search, specialty directory or physician/provider profile URLs. URLs take precedence over the text search.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Maxitems", "minimum": 1, "maximum": 1980, "type": "integer", "description": "Maximum number of unique providers per search or directory, across all cursor pages. Reviews do not consume this provider limit.", "default": 20 }, "includeReviews": { "title": "Includereviews", "type": "boolean", "description": "Return public written reviews as separate rows immediately after their provider.", "default": false }, "maxReviewsPerPlace": { "title": "Maxreviewsperplace", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum written reviews per provider. Healthgrades exposes at most 20 recent written reviews, even when the profile has more.", "default": 20 }, "radiusMiles": { "title": "Radiusmiles", "minimum": 0, "maximum": 100, "type": "integer", "description": "Search radius in miles (1–100); 0 searches nationally. Omit for the source default of 5 miles. Applies to text searches." }, "sortBy": { "title": "Sortby", "enum": [ "bestmatch", "distance", "ratings" ], "type": "string", "description": "Ordering for text searches. URL searches preserve their filters and sort order.", "default": "bestmatch" }, "cursor": { "title": "Cursor", "maxLength": 1000000, "type": "string", "description": "Opaque next_cursor from a previous response. Keep all other inputs unchanged. Apify follows it automatically." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }