/vitals/doctors

POST /api/vitals/doctors

Price: 10 credits

Get a Vitals doctor profile by slug (e.g. mershed-alsamara-ec1iuw) or profile URL: full name, gender, degrees, NPI, specialties, areas of expertise, education, licenses, certifications, spoken languages, years of experience, office locations, accepted insurance plans, awards, affiliated hospitals, biography, patient star rating with per-star breakdown, review counts and an AI-generated review summary.

How to use it

Fetch one Vitals doctor by slug (e.g. mershed-alsamara-ec1iuw) or profile URL. Returns name, first_name/middle_name/last_name, prefix, degrees, gender, npi, image, primary_specialty, specialties (with practicing name and slug), expertise, education, licenses, certifications, languages, years_of_experience, accepts_new_patients, is_telehealth, city/state/zip_code, latitude/longitude, rating (1-5 star avg), rating_count, review_count, ratings_per_star, locations, insurance (accepted plans), awards, affiliated_hospitals, vitals_score, description (biography) and review_summary.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• doctor string required — Vitals doctor slug (e.g. mershed-alsamara-ec1iuw) or a doctor profile URL (examples: "mershed-alsamara-ec1iuw"; minLength: 1)

Response

• @type string (default: "VitalsDoctor")
• id string required
• name string required
• first_name string nullable
• middle_name string nullable
• last_name string nullable
• prefix string nullable
• degrees array (default: [])
• gender string nullable
• npi string nullable
• image string nullable
• alias string nullable
• profile_url string nullable
• primary_specialty string nullable
• specialties array (default: [])
  • @type string (default: "VitalsDoctorSpecialty")
  • id string nullable
  • name string nullable
  • practicing_name string nullable
  • slug string nullable
  • is_primary boolean nullable
• expertise array (default: [])
• education array (default: [])
  • @type string (default: "VitalsDoctorEducation")
  • type string nullable
  • institution string nullable
  • year string nullable
• licenses array (default: [])
  • @type string (default: "VitalsDoctorLicense")
  • type string nullable
  • state string nullable
  • status string nullable
  • expires_at string nullable
• certifications array (default: [])
• languages array (default: [])
• years_of_experience integer nullable
• accepts_new_patients boolean nullable
• is_telehealth boolean nullable
• city string nullable
• state string nullable
• zip_code string nullable
• latitude number nullable
• longitude number nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• ratings_per_star array (default: [])
  • @type string (default: "VitalsRatingStar")
  • stars integer required
  • count integer required
  • percentage integer required
• locations array (default: [])
  • @type string (default: "VitalsDoctorLocation")
  • name string nullable
  • practice_name string nullable
  • phone string nullable
  • address string nullable
  • city string nullable
  • state string nullable
  • zip_code string nullable
  • latitude number nullable
  • longitude number nullable
  • is_primary boolean nullable
  • accepts_medicare boolean nullable
  • accepts_medicaid boolean nullable
  • practice_url string nullable
• insurance array (default: [])
• awards array (default: [])
  • @type string (default: "VitalsDoctorAward")
  • description string nullable
  • year integer nullable
  • image string nullable
• affiliated_hospitals array (default: [])
  • @type string (default: "VitalsAffiliatedHospital")
  • id string nullable
  • name string nullable
  • slug string nullable
  • profile_url string nullable
• vitals_score integer nullable
• description string nullable
• review_summary string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Doctor not found (well-formed slug with no Vitals profile) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.