/ratemds/facilities

POST /api/ratemds/facilities

Price: 10 credits

Get a RateMDs facility (clinic, hospital or urgent care center) by slug or URL: name, category, photo, address, city, phone, website, coordinates, patient star rating with the four-criteria breakdown (cleanliness, facilities, services, value), review count, local ranking, Canadian Dental Care Plan acceptance, every provider practicing there and every patient review.

How to use it

Fetch one RateMDs facility by slug (e.g. ca-on-toronto-fcp-dermatology) or URL. Returns id, name, category, image, address, suite, city/state/country, postal_code, phone, website, latitude/longitude, rating, review_count, the four-criteria rating_cleanliness/rating_facilities/rating_services/rating_value, rank/rank_total, accepting_cdcp, profile_url, the full providers list (doctors practicing at the facility) and the full reviews list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• facility string required — RateMDs facility slug (e.g. ca-on-toronto-fcp-dermatology) or a clinic, hospital or urgent care profile URL (examples: "ca-on-toronto-fcp-dermatology"; minLength: 1)

Response

• @type string (default: "RatemdsFacility")
• id string required
• name string required
• category string nullable
• image string nullable
• address string nullable
• suite string nullable
• city string nullable
• state string nullable
• country string nullable
• postal_code string nullable
• phone string nullable
• website string nullable
• latitude number nullable
• longitude number nullable
• rating number nullable
• review_count integer nullable
• rating_cleanliness number nullable
• rating_facilities number nullable
• rating_services number nullable
• rating_value number nullable
• rank integer nullable
• rank_total integer nullable
• accepting_cdcp boolean nullable
• profile_url string nullable
• providers array (default: [])
  • @type string (default: "RatemdsFacilityProvider")
  • id string nullable
  • name string nullable
  • primary_specialty string nullable
  • image string nullable
  • rating number nullable
  • review_count integer nullable
  • profile_url string nullable
• reviews array (default: [])
  • @type string (default: "RatemdsFacilityReview")
  • id string required
  • rating number nullable
  • rating_cleanliness number nullable
  • rating_facilities number nullable
  • rating_services number nullable
  • rating_value number nullable
  • text 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 slug with no RateMDs facility) 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.