/caloo/hospitals

POST /api/caloo/hospitals

Price: 5 credits

Get a hospital, clinic or dental clinic profile from Caloo (病院口コミ検索カルー): name, rating, review and postcard counts, address, coordinates, stations, weekly hours, specialties, specialists, outpatient specialities, treatments, vaccinations, doctors, interviews, guidance, DPC treatment results and page views

How to use it

Hospital ids come from caloo/hospitals/search. Patient reviews and postcard surveys are caloo/hospitals/reviews; a specialty, specialist or treatment code from this record is a keyword for caloo/hospitals/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• hospital string required — Caloo hospital id or hospital URL (examples: "4130005266", "https://caloo.jp/hospitals/detail/4130005266"; minLength: 1)

Response

• @type string (default: "CalooHospital")
• id string required
• url string required
• name string nullable
• name_kana string nullable
• is_official boolean nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• postcard_count integer nullable
• phone string nullable
• website string nullable
• postal_code string nullable
• address string nullable
• prefecture object nullable
  • @type string (default: "CalooArea")
  • code string required
  • name string nullable
• city object nullable
  • @type string (default: "CalooArea")
  • code string required
  • name string nullable
• town object nullable
  • @type string (default: "CalooArea")
  • code string required
  • name string nullable
• latitude number nullable
• longitude number nullable
• stations array (default: [])
  • @type string (default: "CalooStation")
  • id string required
  • name string nullable
• access string nullable
• image string nullable
• images array (default: [])
• catch_copy string nullable
• description string nullable
• features array (default: [])
• hours array (default: [])
  • @type string (default: "CalooHours")
  • day string required
  • periods array (default: [])
• closed_days string nullable
• booking_url string nullable
• booking_note string nullable
• my_number_card string nullable
• smartphone_my_number_card string nullable
• cashless_payment string nullable
• parking string nullable
• designations array (default: [])
• managing_doctor string nullable
• specialties array (default: [])
  • @type string (default: "CalooTaxon")
  • code string required
  • name string nullable
  • group string nullable
• specialists array (default: [])
  • @type string (default: "CalooTaxon")
  • code string required
  • name string nullable
  • group string nullable
• outpatient_specialties array (default: [])
  • @type string (default: "CalooTaxon")
  • code string required
  • name string nullable
  • group string nullable
• treatments array (default: [])
  • @type string (default: "CalooTaxon")
  • code string required
  • name string nullable
  • group string nullable
• vaccinations array (default: [])
  • @type string (default: "CalooTaxon")
  • code string required
  • name string nullable
  • group string nullable
• other_info array (default: [])
  • @type string (default: "CalooInfoRow")
  • label string required
  • value string nullable
• doctors array (default: [])
  • @type string (default: "CalooDoctor")
  • name string required
  • is_director boolean nullable
  • image string nullable
  • message string nullable
  • career string nullable
  • qualifications array (default: [])
  • societies array (default: [])
• interviews array (default: [])
  • @type string (default: "CalooInterview")
  • url string required
  • series string nullable
  • doctors array (default: [])
  • specialty_name string nullable
  • headline string nullable
  • summary string nullable
  • image string nullable
• guidance array (default: [])
  • @type string (default: "CalooGuidance")
  • text string nullable
  • url string nullable
  • image string nullable
• sections array (default: [])
  • @type string (default: "CalooTextSection")
  • text string nullable
• news string nullable
• fee_info string nullable
• dpc_results array (default: [])
  • @type string (default: "CalooDpcResult")
  • code string required
  • name string nullable
  • category string nullable
  • patient_count integer nullable
  • with_surgery_count integer nullable
  • without_surgery_count integer nullable
  • prefecture_rank integer nullable
  • national_rank integer nullable
• dpc_period string nullable
• latest_month_views integer nullable
• previous_month_views integer nullable
• annual_views integer nullable

Errors

• 422 — hospital is not a Caloo hospital id or URL 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 — No Caloo hospital under that id 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.