{
  "openapi": "3.0.1",
  "info": {
    "title": "Healthgrades Scraper — Doctors, Reviews & Provider Leads",
    "description": "Scrape Healthgrades doctors & healthcare providers by specialty and location, or from profile URLs. Get NPI, specialties, ratings, patient reviews, education, board certifications, locations, phones & leads — plus optional practice-email enrichment and monitoring. No login, no browser.",
    "version": "0.1",
    "x-build-id": "DOBnHccCIIxKxTXm5"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~healthgrades-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~healthgrades-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-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/scrapesage~healthgrades-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-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": {
          "searchQueries": {
            "title": "Search terms (specialty, condition or doctor name)",
            "type": "array",
            "description": "What to search for on Healthgrades — a specialty (`Dentistry`, `Cardiology`, `Dermatology`), a condition/procedure, or a doctor's name. Each term is combined with every location below. Leave empty if you only use Start URLs.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Locations (City, ST or ZIP)",
            "type": "array",
            "description": "Where to search — `City, ST` (e.g. `New York, NY`, `Austin, TX`) or a 5-digit ZIP code. Each location is paired with every search term. Required for search; ignored for Start URLs.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs (provider profiles or search pages)",
            "type": "array",
            "description": "Paste Healthgrades provider profile URLs (`/physician/...`, `/dentist/...`) or search-result URLs (`/usearch?what=...&where=...`). Processed in addition to any search terms above.",
            "items": {
              "type": "string"
            }
          },
          "maxProvidersPerSearch": {
            "title": "Max providers per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Cap the number of providers collected per search term + location pair (each results page has ~20 providers). Raise it for bigger pulls — opening every profile for full details is the slow part, so very large caps need a higher run timeout.",
            "default": 30
          },
          "maxProviders": {
            "title": "Max providers (whole run)",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Global cap on the total number of provider records emitted in this run, across all searches and Start URLs.",
            "default": 200
          },
          "acceptingNewPatientsOnly": {
            "title": "Only providers accepting new patients",
            "type": "boolean",
            "description": "Keep only providers flagged as accepting new patients.",
            "default": false
          },
          "minRating": {
            "title": "Minimum star rating",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Keep only providers with an overall star rating at or above this value (0 = no filter). Rated 1-5.",
            "default": 0
          },
          "gender": {
            "title": "Gender",
            "enum": [
              "any",
              "M",
              "F"
            ],
            "type": "string",
            "description": "Optionally keep only male or female providers.",
            "default": "any"
          },
          "telehealthOnly": {
            "title": "Only providers offering telehealth",
            "type": "boolean",
            "description": "Keep only providers that offer telehealth visits.",
            "default": false
          },
          "includeProviderDetails": {
            "title": "Open each profile for full details",
            "type": "boolean",
            "description": "Visit each provider's profile page to add the deep fields: education, residencies, board certifications, certifying agencies, languages, accepted insurance, all practice locations with geo, fax, hospital affiliations, conditions treated, procedures and awards. One extra request per provider.",
            "default": true
          },
          "includeReviews": {
            "title": "Include patient reviews",
            "type": "boolean",
            "description": "Also output patient review records (type `review`) from each provider's profile — star rating, review text, author and date (most recent batch shown on the profile). Requires opening profiles.",
            "default": false
          },
          "maxReviewsPerProvider": {
            "title": "Max reviews per provider",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many reviews to emit per provider when 'Include patient reviews' is on.",
            "default": 25
          },
          "enrichPracticeEmails": {
            "title": "Enrich practice contacts (crawl website for emails, phone, socials)",
            "type": "boolean",
            "description": "Opt-in lead enrichment: when a provider/practice website is found, visit it (home + a contact/about page) and extract contact emails, phone numbers and social links — for medical sales, recruiting and partnership outreach. Only runs when a website exists.",
            "default": false
          },
          "deduplicateProviders": {
            "title": "Deduplicate providers",
            "type": "boolean",
            "description": "Emit each provider only once per run (keyed by NPI / profile URL), even if they appear in multiple searches or locations.",
            "default": true
          },
          "monitorMode": {
            "title": "Monitoring mode — only new providers",
            "type": "boolean",
            "description": "Remember providers already returned and emit ONLY providers not seen in previous runs (new doctors/practices for a search). Pairs with Apify Schedules to track new providers in a specialty or area over time.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor store name",
            "type": "string",
            "description": "Named key-value store that holds the 'already seen' provider ids for monitoring mode. Use a different name per tracked search to keep their histories separate.",
            "default": "healthgrades-monitor"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum parallel requests. Raise it to pull large result sets faster (uses more memory — give the run 2 GB+ if you push it high); lower it if you hit rate limits on very large runs.",
            "default": 6
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. Healthgrades serves clean pages to US IPs, so the default Apify proxy is enough; switch to residential for very large or high-frequency runs.",
            "default": {
              "useApifyProxy": true,
              "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}