/vitals/practices

POST /api/vitals/practices

Price: 10 credits

Get a Vitals group practice profile by slug or profile URL: name, address, phone, description, rating and review counts, specialty and provider counts, spoken languages, accepted insurance, medical specialties and a sample of affiliated providers.

How to use it

Fetch one Vitals group practice by slug or profile URL. Returns name, address/city/state/zip_code, phone, web_url, description, latitude/longitude, rating, rating_count, review_count, specialty_count, provider_count, accepts_medicare/accepts_medicaid, languages, specialties, insurance, locations and providers (a sample of affiliated doctors).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• practice string required — Vitals group practice slug or practice profile URL (examples: "the-polyclinic-madison-center-056c8df7-9be6-4652-9a37-8618472ec0b5"; minLength: 1)

Response

• @type string (default: "VitalsFacility")
• id string required
• name string required
• address string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• phone string nullable
• web_url string nullable
• description string nullable
• latitude number nullable
• longitude number nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• specialty_count integer nullable
• provider_count integer nullable
• accepts_new_patients boolean nullable
• accepts_medicare boolean nullable
• accepts_medicaid boolean nullable
• languages array (default: [])
• specialties array (default: [])
• insurance array (default: [])
• locations array (default: [])
  • @type string (default: "VitalsFacilityLocation")
  • name string nullable
  • practice_name string nullable
  • phone string nullable
  • address string nullable
  • city string nullable
  • state string nullable
  • zip_code string nullable
• providers array (default: [])
  • @type string (default: "VitalsFacilityProvider")
  • name string nullable
  • alias string nullable
  • image string nullable
  • npi string nullable
  • degrees array (default: [])
  • specialty string nullable
  • rating number nullable
  • rating_count integer nullable
  • accepts_new_patients boolean nullable
  • profile_url string 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 — Group practice 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.