How the API fits together
Try it on a test key
curl -s "https://api.wellwardhealth.com/v1/services/colonoscopy" -H "Authorization: Bearer $WELLWARD_KEY"
The handful of ideas every other page assumes.
Service → variant → add-on
A service is a thing people shop for — colonoscopy, mri-knee — named by a stable slug (Find the right service). A service has one or more variants: the priceable forms of it. A core variant is the service itself in one form (a screening vs. a diagnostic colonoscopy); an add-on variant is billed on top of a core price (pathology, contrast, anesthesia). A price is always for one variant.
Practice and provider
A practice is a place that quoted us a price — a clinic, lab or imaging center at one location. The practice object on a price names it, where it is (geo, with precision: rooftop or zip), and how we identified it (identity_source). The providers endpoints list practices and what we price at each; the prices themselves always come from /prices.
A price, and as_of
A price is what a practice told us it charges a self-pay patient, on a date. as_of is that date. Every price we return was quoted within the last 364 days and has not been withdrawn — prices older than that retire on their own. A price keeps its id when it is re-quoted; a withdrawn price answers 410.
Market vs. radius
You ask for prices near a point: a ZIP (near), coordinates (lat, lng), or a market — a named metro label with its own center and radius. Markets are a convenience; coverage is always measured from a point and a radius.
Coverage levels
For one service near a point, coverage is full (at least 5 prices from at least 4 practices), partial (at least one) or none. /coverage tells you, free, before you ask for prices (Check coverage before you query).
A Read, and a price request
A Read is a live call that returns prices (or a benchmark) — the unit you are billed in; each page of results is one Read. A price request asks us to go and gather a price we don't have; it is billed only if we obtain one. The rates are on the pricing page; the definitions are in Billing.
API reference · Dashboard · Questions: hello@wellwardhealth.com