{ "openapi": "3.0.1", "info": { "title": "Healthgrades Scraper — Doctors & Practice Leads", "description": "Export clean, deduplicated Healthgrades provider leads in minutes: name, specialty, ratings and practice locations, plus the practice website, emails and social profiles when listed. Add specialty + city, stream results to your dataset or CRM as they are found. Free plan: limited sample.", "version": "0.0", "x-build-id": "z9j8Hdb2fedBBhdq0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~Healthgrades-Real-Time-Data-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-Healthgrades-Real-Time-Data-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/b2b_leads~Healthgrades-Real-Time-Data-Scraper/runs": { "post": { "operationId": "runs-sync-b2b_leads-Healthgrades-Real-Time-Data-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/b2b_leads~Healthgrades-Real-Time-Data-Scraper/run-sync": { "post": { "operationId": "run-sync-b2b_leads-Healthgrades-Real-Time-Data-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": { "enableSearch": { "title": "Search", "type": "boolean", "description": "Search Healthgrades by specialty and location. Enabled by default.", "default": true }, "searchTasks": { "title": "Search tasks", "type": "array", "description": "Add one row per search. Pair a specialty with a city or area. Add more rows to run several searches (and several cities) in one go.", "items": { "type": "object", "properties": { "query": { "title": "Specialty", "type": "string", "description": "Specialty or doctor name to search (e.g. \"dermatologist\", \"cardiologist\", \"family medicine\").", "editor": "textfield" }, "location": { "title": "Location", "type": "string", "description": "City or area for this search (e.g. \"Miami, FL\", \"Dallas, TX\"). Keep \"City, ST\" format for best precision.", "editor": "textfield" }, "maxResults": { "title": "Max providers", "type": "integer", "description": "Maximum providers for this task. Uses the global default below if omitted.", "minimum": 1, "editor": "number" } }, "required": [ "query" ] } }, "maxResultsPerQuery": { "title": "Default max providers per task", "minimum": 1, "type": "integer", "description": "Default maximum providers per search task. A row's own Max providers value overrides it. Raise this to collect more per task.", "default": 10 }, "enableProviderDetails": { "title": "Provider Details", "type": "boolean", "description": "Collect full structured profiles for specific provider profile URLs.", "default": false }, "providerUrls": { "title": "Provider profile URLs", "type": "array", "description": "Healthgrades provider profile URLs.", "default": [], "items": { "type": "string" } }, "npiNumbers": { "title": "NPI numbers", "type": "array", "description": "Reserved for identifier-based lookups. Currently a no-op; use profile URLs instead.", "default": [], "items": { "type": "string" } }, "enableLeadDetails": { "title": "Enable lead details", "type": "boolean", "description": "Enrich every provider with extra lead details (practice website, emails, social profiles) where they can be found. Adds a little extra time per provider. Every provider is still exported even when no extra details are found — output stays complete and predictable.", "default": true }, "maxItems": { "title": "Max total items", "minimum": 1, "type": "integer", "description": "Global cap on total rows for the whole run, across all tasks and features. Raise it for large jobs (e.g. 10000). Free Apify accounts are capped to a small sample per run regardless of this value.", "default": 10 }, "language": { "title": "Language", "type": "string", "description": "Language for provider names and addresses (e.g. en, es).", "default": "en" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. Every record is always saved to the run's dataset — this webhook is an ADDITIONAL real-time push. When set, each new record is also POSTed to this URL (CRM, Slack incoming webhook, Zapier, Make, Google Sheets).", "default": "" }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "json = full record object; slack = Slack-friendly message payload.", "default": "json" }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "A US residential connection is enabled by default for reliable collection.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }