{
  "openapi": "3.0.1",
  "info": {
    "title": "Vitals.com Doctor Scraper - NPI, Phone, Reviews & Insurance",
    "description": "Scrape Vitals.com doctors and dentists by specialty and city or state, or from profile links: NPI, office phone, address, ZIP, GPS, rating, reviews, education, licences, hospitals, insurances, Medicare/Medicaid and the newest patient review texts. No login.",
    "version": "0.1",
    "x-build-id": "3aKmOaBYciE9L4zCJ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapersdelight~vitals-doctor-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapersdelight-vitals-doctor-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/scrapersdelight~vitals-doctor-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapersdelight-vitals-doctor-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/scrapersdelight~vitals-doctor-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapersdelight-vitals-doctor-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": "One or more specialties, in everyday words: \"Cardiology\", \"Family Medicine\", \"Dentist\", \"Dermatologist\", \"OB-GYN\". Any Vitals specialty works (e.g. \"Anesthesiology\"). Each specialty is searched in every location below.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "📍 Locations",
            "type": "array",
            "description": "\"City, ST\" (e.g. \"Houston, TX\", \"St. Louis, MO\") for a city and its area, or a state (\"TX\", \"California\") for the whole state. Leave empty to search nationwide.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 Vitals.com URLs",
            "type": "array",
            "description": "Optional. Specialty pages (vitals.com/cardiology/ny/new-york, /dermatology/ca, /pediatrics, ?page=N honoured), doctor profiles (vitals.com/doctors/{name-id}, /dentists/...) and vitals.com/search links (read as the matching specialty + city).",
            "items": {
              "type": "string"
            }
          },
          "gender": {
            "title": "Gender",
            "enum": [
              "any",
              "female",
              "male"
            ],
            "type": "string",
            "description": "Keep only doctors of this gender. Doctors whose gender Vitals does not show are dropped when a gender is picked.",
            "default": "any"
          },
          "minRating": {
            "title": "Minimum rating",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "4.5",
              "5"
            ],
            "type": "string",
            "description": "Keep doctors rated at least this many stars (Vitals' average patient rating). Unrated doctors are dropped when a floor is set.",
            "default": "0"
          },
          "minReviewCount": {
            "title": "Minimum ratings",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Keep doctors with at least this many patient ratings. 0 keeps everyone.",
            "default": 0
          },
          "acceptingNewPatientsOnly": {
            "title": "Accepting new patients only",
            "type": "boolean",
            "description": "Keep only doctors Vitals marks as accepting new patients at one or more offices.",
            "default": false
          },
          "telehealthOnly": {
            "title": "Telehealth / virtual visits only",
            "type": "boolean",
            "description": "Keep only doctors who offer virtual visits on Vitals.",
            "default": false
          },
          "minYearsExperience": {
            "title": "Minimum years of experience",
            "minimum": 0,
            "maximum": 80,
            "type": "integer",
            "description": "Keep doctors with at least this many years in practice. 0 = no floor. Doctors without a stated figure are dropped when a floor is set.",
            "default": 0
          },
          "maxYearsExperience": {
            "title": "Maximum years of experience",
            "minimum": 0,
            "maximum": 80,
            "type": "integer",
            "description": "Keep doctors with at most this many years in practice. 0 = no ceiling.",
            "default": 0
          },
          "languages": {
            "title": "Speaks any of",
            "type": "array",
            "description": "Keep doctors who speak one of these languages, e.g. \"Spanish\", \"Mandarin\". Empty keeps everyone.",
            "items": {
              "type": "string"
            }
          },
          "nameContains": {
            "title": "Name contains",
            "type": "array",
            "description": "Keep doctors whose name contains one of these words, e.g. \"Patel\". Works inside the specialty and location you search.",
            "items": {
              "type": "string"
            }
          },
          "excludeSponsored": {
            "title": "Skip sponsored profiles",
            "type": "boolean",
            "description": "Vitals places some paid (\"Sponsored\") profiles in its lists. Turn on to keep only the others.",
            "default": false
          },
          "requirePhone": {
            "title": "Only doctors with a phone",
            "type": "boolean",
            "description": "Drop doctors with no office phone on Vitals.",
            "default": false
          },
          "acceptsMedicareOnly": {
            "title": "Accepts Medicare",
            "type": "boolean",
            "description": "Keep only doctors whose Vitals profile says they accept Medicare. Reads the profile, so profile details turn on.",
            "default": false
          },
          "acceptsMedicaidOnly": {
            "title": "Accepts Medicaid",
            "type": "boolean",
            "description": "Keep only doctors whose Vitals profile says they accept Medicaid. Reads the profile, so profile details turn on.",
            "default": false
          },
          "insuranceContains": {
            "title": "Accepts insurance",
            "type": "array",
            "description": "Keep doctors whose accepted-insurance list contains one of these words, e.g. \"Aetna\", \"Cigna\", \"Blue Cross\". Reads the profile.",
            "items": {
              "type": "string"
            }
          },
          "includeDetails": {
            "title": "Profile details",
            "type": "boolean",
            "description": "ON: opens each doctor's profile for full office address, ZIP, GPS, every office with hours, education, licences, certifications, hospitals, insurances, Medicare/Medicaid and the rating breakdown. OFF: list data only (name, NPI, phone, city, rating) - about 40x fewer page loads.",
            "default": true
          },
          "includeReviews": {
            "title": "Recent patient reviews",
            "type": "boolean",
            "description": "Adds the newest written reviews shown on the profile (text, star rating, date, helpful votes). Needs profile details.",
            "default": true
          },
          "maxReviewsPerDoctor": {
            "title": "Reviews per doctor",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "How many of the newest reviews to keep per doctor. The profile page shows up to 10.",
            "default": 10
          },
          "monitorMode": {
            "title": "Only new doctors (monitor)",
            "type": "boolean",
            "description": "Deliver only doctors this monitor has not delivered in earlier runs. Pairs with a daily or weekly schedule. Doctors filtered out are re-checked next run.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Name of the key-value store that remembers delivered doctors. Use a different name for each list you watch.",
            "default": "vitals-doctor-monitor"
          },
          "maxItems": {
            "title": "Max doctors",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many doctors in total (across all searches and links). 0 = no limit. A big-city specialty can list 3,000+ doctors and a state 6,000+.",
            "default": 100
          },
          "maxItemsPerSearch": {
            "title": "Max doctors per search",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Cap for each specialty x location (and each link). 0 = only the total cap applies.",
            "default": 0
          },
          "maxPagesPerSearch": {
            "title": "Max list pages per search",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Vitals shows 60 doctors per city page and 65 per state or nationwide page. 0 = as many pages as the caps need; a search whose filters match nothing for 20 pages in a row stops on its own.",
            "default": 0
          },
          "flattenForCsv": {
            "title": "Flatten for CSV / spreadsheets",
            "type": "boolean",
            "description": "Turns lists into text (languages joined with \"; \", offices, education and reviews as JSON text) so every row is one flat line.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Leave as is. The actor reads Vitals directly, switches to a US residential proxy by itself if Vitals refuses the connection, and uses Apify's Unblocker for list pages only as a last resort. Bring your own proxy URLs only if you have them.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}