/ratemds/facilities/search

POST /api/ratemds/facilities/search

Price: 10 credits

Search RateMDs healthcare facilities (clinics, hospitals, urgent care centers) within a country market (US, Canada, Australia & New Zealand, India, South Africa), optionally narrowed by region and city path and by a name query. Returns each facility's name, star rating, local rank, city and profile URL.

How to use it

Search RateMDs facilities by country (us, ca, au_nz, india, south_africa, all), optionally narrowed by region + city slugs and a name query. Each result has id (slug), name, rating, rank, city/state/country and profile_url.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string — Country market to search within; the uk market is currently unavailable at the source (default: "us"; one of: "us", "ca", "uk", "au_nz", "india", "south_africa", "all")
• region string nullable — State / province / region slug (e.g. on, ny, nsw); can be used without a city (examples: "on")
• city string nullable — City slug (e.g. toronto, new-york); requires region (examples: "toronto")
• name string nullable — Free-text query matched against the facility name (examples: "dermatology")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "RatemdsFacilitySearchResult")
• id string nullable
• name string nullable
• category string nullable
• rating number nullable
• rank integer nullable
• city string nullable
• state string nullable
• country 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 — The requested country market or region/city did not resolve on RateMDs 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.