/healthgrades/providers

POST /api/healthgrades/providers

Price: 20 credits

Get a Healthgrades provider profile by id (e.g. y25mp), profile slug or profile URL: full name, gender, NPI, age, medical and practicing specialties, board certifications, education, spoken languages, office locations with hours, accepted insurance, patient star rating with per-star breakdown and subcategory scores, clinical experience (conditions and procedures treated), affiliated hospitals with awards, highlights and biography.

How to use it

Fetch one Healthgrades provider (doctor, dentist, nurse practitioner, etc.) by id (e.g. y25mp), slug or profile URL. Returns name, first_name/last_name, gender, npi, age, image, primary_specialty, medical_specialty, specialties, accepts_new_patients, is_telehealth, languages, education, board_certifications, description (biography), rating (1-5 avg), rating_count, review_count, ratings_per_star, review_subscores, highlights, offices (with hours), insurance, experience (conditions/procedures treated) and affiliated_hospitals (with awards).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• provider string required — Healthgrades provider id (e.g. y25mp), profile slug or profile URL (examples: "y25mp"; minLength: 1)

Response

• @type string (default: "HealthgradesProvider")
• id string required
• name string required
• first_name string nullable
• last_name string nullable
• gender string nullable
• npi string nullable
• age integer nullable
• image string nullable
• profile_url string nullable
• primary_specialty string nullable
• medical_specialty string nullable
• specialties array (default: [])
  • @type string (default: "HealthgradesProviderSpecialty")
  • name string nullable
  • code string nullable
  • is_primary boolean nullable
  • directory_url string nullable
• professional_type string nullable
• accepts_new_patients boolean nullable
• is_telehealth boolean nullable
• languages array (default: [])
• education array (default: [])
  • @type string (default: "HealthgradesEducation")
  • education_type string nullable
  • institution string nullable
  • year integer nullable
  • status string nullable
• board_certifications array (default: [])
  • @type string (default: "HealthgradesBoardCertification")
  • name string nullable
  • board string nullable
• description string nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• ratings_per_star array (default: [])
  • @type string (default: "HealthgradesRatingStar")
  • stars integer required
  • count integer required
  • percentage integer required
• review_subscores array (default: [])
  • @type string (default: "HealthgradesReviewSubscore")
  • category string nullable
  • score number nullable
  • rating_text string nullable
• highlights array (default: [])
  • @type string (default: "HealthgradesHighlight")
  • category string nullable
  • text string nullable
• offices array (default: [])
  • @type string (default: "HealthgradesOffice")
  • id string nullable
  • name string nullable
  • practice_name string nullable
  • address string nullable
  • city string nullable
  • state string nullable
  • zip_code string nullable
  • phone string nullable
  • fax string nullable
  • latitude number nullable
  • longitude number nullable
  • is_primary boolean nullable
  • directions_url string nullable
  • hours array (default: [])
    • @type string (default: "HealthgradesOfficeHours")
    • day string nullable
    • start_time string nullable
    • end_time string nullable
    • is_closed boolean nullable
    • is_open_24h boolean nullable
• insurance array (default: [])
  • @type string (default: "HealthgradesInsurance")
  • payor string nullable
  • code string nullable
  • plans array (default: [])
    • @type string (default: "HealthgradesInsurancePlan")
    • name string nullable
    • plan_type string nullable
• experience array (default: [])
  • @type string (default: "HealthgradesExperience")
  • name string nullable
  • code string nullable
  • is_condition boolean nullable
  • percentile integer nullable
  • volume integer nullable
  • national_ranking integer nullable
  • url string nullable
• affiliated_hospitals array (default: [])
  • @type string (default: "HealthgradesAffiliatedHospital")
  • id string nullable
  • name string nullable
  • street string nullable
  • city string nullable
  • state string nullable
  • zip_code string nullable
  • total_award_count integer nullable
  • profile_url string nullable
  • awards array (default: [])
    • @type string (default: "HealthgradesAward")
    • code string nullable
    • name string nullable
    • years array (default: [])
    • category string nullable
    • summary string nullable
    • is_top_award boolean 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 — Provider not found (well-formed id with no Healthgrades 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.