/healthgrades/facilities/search

POST /api/healthgrades/facilities/search

Price: 20 credits

List Healthgrades group practices (medical offices, including urgent care clinics that have a profile) in a US city. Returns each facility's name, address, distance and affiliated provider count.

How to use it

List Healthgrades group practices in a US city by state and city. Each result has id (facility id), name, facility_type, description, address/city/state/zip_code, latitude/longitude, phone, distance, affiliated_provider_count, hours (day/start/end/is_closed, when published), five_star_rating_count, award_count, awards, image and profile_url (description/awards/rating/patient_satisfaction/facility_type_code fields are populated for hospitals; group practices are leaner but may carry hours). Feed id into the facilities endpoint for the full profile.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• state string required — US state to search in (one of: "al", "ak", "az", "ar", "ca", "co", "ct", "de", "dc", "fl", "ga", "hi", "id", "il", "in", "ia", "ks", "ky", "la", "me", "md", "ma", "mi", "mn", "ms", "mo", "mt", "ne", "nv", "nh", "nj", "nm", "ny", "nc", "nd", "oh", "ok", "or", "pa", "ri", "sc", "sd", "tn", "tx", "ut", "vt", "va", "wa", "wv", "wi", "wy")
• city string required — City to search in (examples: "New York"; minLength: 1)
• sort string — Result ordering (default: "distance"; one of: "relevance", "distance", "rating")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "HealthgradesFacilitySearchResult")
• id string nullable
• name string nullable
• facility_type string nullable
• facility_type_code string nullable
• description string nullable
• address string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• latitude number nullable
• longitude number nullable
• phone string nullable
• distance number nullable
• affiliated_provider_count integer nullable
• patient_satisfaction integer nullable
• five_star_rating_count integer nullable
• award_count integer nullable
• awards array (default: [])
• image string nullable
• hours array (default: [])
  • @type string (default: "HealthgradesHours")
  • day string nullable
  • start string nullable
  • end string nullable
  • is_closed boolean 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.