/healthgrades/facilities

POST /api/healthgrades/facilities

Price: 20 credits

Get a Healthgrades group practice (medical office) profile by id (e.g. x8g96p), profile slug or profile URL: name, address, phone, fax, office hours, accepted insurance, spoken languages, practice categories, offered services, provider and patient rating counts and a sample of affiliated providers.

How to use it

Fetch one Healthgrades group practice (medical office) by id (e.g. x8g96p), slug or profile URL. Returns name, office_name, address/city/state/zip_code, phone, fax, latitude/longitude, product_tier, provider_count, telehealth_provider_count, rating (aggregate provider rating), rating_count, review_count, office_rating, office_review_count, practice_categories, services, languages, office_hours, insurance, providers (affiliated doctors) and faqs.

Parameters

• access-token string required

Request body

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

Response

• @type string (default: "HealthgradesFacility")
• id string required
• name string required
• office_name string nullable
• practice_id string nullable
• phone string nullable
• fax string nullable
• address string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• latitude number nullable
• longitude number nullable
• profile_url string nullable
• product_tier string nullable
• provider_count integer nullable
• telehealth_provider_count integer nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• office_rating number nullable
• office_review_count integer nullable
• practice_categories array (default: [])
• services array (default: [])
• languages array (default: [])
• office_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
• providers array (default: [])
  • @type string (default: "HealthgradesProviderCard")
  • id string nullable
  • name string nullable
  • npi string nullable
  • image string nullable
  • specialty string nullable
  • rating number nullable
  • rating_count integer nullable
  • profile_url string nullable
• faqs array (default: [])
  • @type string (default: "HealthgradesFaq")
  • question string nullable
  • answer string nullable
  • faq_type 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 — Facility 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.