/caloo/dpc/rankings

POST /api/caloo/dpc/rankings

Price: 10 credits

Get DPC treatment results for one disease from Caloo (病院口コミ検索カルー), nationwide or in one prefecture: case counts and mean stay per procedure, and the hospital ranking by case count

How to use it

DPC codes appear in dpc_results of caloo/hospitals. A ranked hospital_id is an id for caloo/hospitals.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• code string required — DPC disease code or Caloo DPC page URL (examples: "010010", "https://caloo.jp/dpc/code/010010")
• prefecture string nullable — Prefecture code; omit for the national ranking (examples: "13")

Response

• @type string (default: "CalooDpcDisease")
• code string required
• name string nullable
• prefecture_code string nullable
• prefecture string nullable
• procedures array (default: [])
  • @type string (default: "CalooDpcProcedure")
  • name string required
  • case_count integer nullable
  • mean_stay_days number nullable
• rankings array (default: [])
  • @type string (default: "CalooDpcRanking")
  • rank integer nullable
  • prefecture string nullable
  • hospital_id string nullable
  • hospital_name string nullable
  • case_count integer nullable
  • procedure_counts array (default: [])
    • @type string (default: "CalooDpcCount")
    • procedure string required
    • case_count integer nullable

Errors

• 422 — code is not a DPC code 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 DPC ranking under that code and prefecture 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.