/byoinnavi/clinics

POST /api/byoinnavi/clinics

Price: 10 credits

Get a clinic, hospital or pharmacy profile from Byoinnavi (病院なび): name, director, address, coordinates, nearest station, phone, website, specialties, features, weekly hours, doctors, board-certified specialists, treatable diseases, treatments, cooperating facilities, rating and interviews

How to use it

Clinic ids come from byoinnavi/clinics/search; patient reviews are byoinnavi/clinics/reviews.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• clinic string required — Byoinnavi clinic or pharmacy id or URL (examples: "16878", "https://byoinnavi.jp/clinic/16878", "https://byoinnavi.jp/pharm/205642"; minLength: 1)

Response

• @type string (default: "ByoinnaviClinic")
• id string required
• url string required
• facility_type string required
• name string nullable
• director string nullable
• address string nullable
• prefecture object nullable
  • @type string (default: "ByoinnaviArea")
  • alias string required
  • name string nullable
• city object nullable
  • @type string (default: "ByoinnaviArea")
  • alias string required
  • name string nullable
• latitude number nullable
• longitude number nullable
• nearest_station string nullable
• station_distance string nullable
• access string nullable
• phone string nullable
• website string nullable
• specialties array (default: [])
• features array (default: [])
• feature_details array (default: [])
• reservation_options array (default: [])
• reserve_links array (default: [])
  • @type string (default: "ByoinnaviReserveLink")
  • label string nullable
  • url string nullable
  • phone string nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• images array (default: [])
• message string nullable
• hours array (default: [])
  • @type string (default: "ByoinnaviHours")
  • day string required
  • periods array (default: [])
• hours_note string nullable
• closed_days string nullable
• doctors array (default: [])
  • @type string (default: "ByoinnaviDoctor")
  • name string required
  • role string nullable
• specialists array (default: [])
  • @type string (default: "ByoinnaviSpecialist")
  • name string required
  • organization string nullable
  • employment string nullable
• treatable_diseases array (default: [])
• treatments array (default: [])
  • @type string (default: "ByoinnaviTreatment")
  • name string required
  • is_self_pay boolean nullable
• intractable_diseases array (default: [])
  • @type string (default: "ByoinnaviIntractableDisease")
  • name string required
  • level string nullable
• cooperating_facilities array (default: [])
  • @type string (default: "ByoinnaviLinkedFacility")
  • id string required
  • name string nullable
• cooperation_note string nullable
• interviews array (default: [])
  • @type string (default: "ByoinnaviInterview")
  • url string nullable
  • doctors array (default: [])
    • @type string (default: "ByoinnaviDoctor")
    • name string required
    • role string nullable
  • question string nullable
  • answer string nullable
  • image string nullable

Errors

• 422 — clinic is not a Byoinnavi clinic or pharmacy 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 Byoinnavi facility 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.