/caloo/hospitals/search

POST /api/caloo/hospitals/search

Price: 10 credits

Search hospitals, clinics and dental clinics on Caloo (病院口コミ検索カルー) by area or station, specialty, specialist, symptom, disease or treatment, facility features, opening day and hour and name: rating, review and postcard counts, address, stations, features, review snippets, specialties, weekly hours and contacts

How to use it

Area codes are JIS prefecture (13) or city (13101) codes or station ids (s1130203); keyword codes come from caloo/specialties and caloo/diseases. Pass a returned id to caloo/hospitals for the full profile.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• area string — Caloo area: all, prefecture code, city code, town id or station id (default: "all"; examples: "13", "13101", "s1130203", "all")
• keyword string — Caloo specialty, specialist, outpatient, symptom, disease, treatment or vaccination code (default: "all"; examples: "k1", "i78", "g1", "s55", "d1339", "t596", "v9", "all")
• features array nullable — Facility features; all must match (one of: "female_doctor", "parking", "cashless_payment", "online_booking", "my_number_card", "e_prescription", "smartphone_my_number_card"; examples: ["female_doctor"])
• weekday string nullable — Open on this day (one of: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday", "holiday")
• hour integer nullable — Open at this hour of the day (JST) on weekday (examples: 19; min: 0; max: 23)
• name string nullable — Text in the hospital name (examples: "外科"; minLength: 1)
• sort string — Result order (default: "default"; one of: "default", "rating", "review_count", "newest")
• count integer required — Max number of results (min: 1; max: 1400)

Response

• @type string (default: "CalooHospitalCard")
• id string required
• url string required
• name string nullable
• flags array (default: [])
• address string nullable
• stations array (default: [])
  • @type string (default: "CalooStation")
  • id string required
  • name string nullable
• features array (default: [])
• image string nullable
• catch_copy string nullable
• rating number nullable
• review_count integer nullable
• postcard_count integer nullable
• keyword_title string nullable
• keyword_info array (default: [])
  • @type string (default: "CalooInfoRow")
  • label string required
  • value string nullable
• review_snippets array (default: [])
  • @type string (default: "CalooReviewSnippet")
  • id string required
  • text string nullable
  • tags string nullable
  • rating number nullable
• specialty_names array (default: [])
• specialist_names array (default: [])
• news string nullable
• hours array (default: [])
  • @type string (default: "CalooHours")
  • day string required
  • periods array (default: [])
• phone string nullable
• booking_url string nullable
• website string nullable
• latest_month_views integer nullable
• previous_month_views integer nullable
• annual_views integer 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 — Caloo serves no result list for this combination of filters 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.