/healthgrades/providers/search

POST /api/healthgrades/providers/search

Price: 20 credits

Search Healthgrades providers by specialty, condition, procedure or name near a US location, with optional filters for gender, minimum patient rating and accepted insurance. Returns each provider's name, gender, specialty, distance, patient rating, office location and telehealth and accepting-new-patients flags.

How to use it

Search Healthgrades providers. 'what' accepts a specialty, condition, procedure or provider name; 'where' is a city, 'City, State' or ZIP. Optional filters: gender, min_rating (1-5), insurance_codes (payor codes) and sort. Each result has id, name, gender, npi, age, image, primary_specialty, specialties, description, years_since_graduation, accepts_new_patients, is_telehealth, is_hg_choice, distance, rating, rating_count, address/city/state/zip_code, phone, insurance_codes, affiliated_hospital_ids, strengths and profile_url.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• what string required — Specialty, condition, procedure or provider name to search for (examples: "Cardiology"; minLength: 1)
• where string required — Location to search near: city, 'City, State' or ZIP code (examples: "New York, NY"; minLength: 1)
• gender string nullable — Filter providers by gender (one of: "male", "female")
• min_rating integer nullable — Minimum patient star rating (1-5) a provider must have (min: 1; max: 5)
• insurance_codes array nullable — Filter by accepted insurance payor codes (from a provider or facility 'insurance' code)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "distance", "rating")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "HealthgradesProviderSearchResult")
• id string nullable
• name string nullable
• gender string nullable
• npi string nullable
• age integer nullable
• image string nullable
• primary_specialty string nullable
• specialties array (default: [])
• description string nullable
• years_since_graduation integer nullable
• accepts_new_patients boolean nullable
• is_telehealth boolean nullable
• is_hg_choice boolean nullable
• is_patient_favorite boolean nullable
• distance number nullable
• rating number nullable
• rating_count integer nullable
• rating_percent integer nullable
• address string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• phone string nullable
• latitude number nullable
• longitude number nullable
• insurance_codes array (default: [])
• affiliated_hospital_ids array (default: [])
• strengths array (default: [])
  • @type string (default: "HealthgradesProviderStrength")
  • label string nullable
  • count integer nullable
• profile_url 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 — The entity was not found, or a precondition failed 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.