/byoinnavi/clinics/search

POST /api/byoinnavi/clinics/search

Price: 10 credits

Search clinics, hospitals and pharmacies on Byoinnavi (病院なび) by prefecture or city, specialty, facility features and keyword: name, rating, review count, address, coordinates, stations, phone, specialties, weekly hours, closed days and booking links

How to use it

Area codes come from byoinnavi/areas and specialty codes from byoinnavi/specialties. Pass a returned id to byoinnavi/clinics 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 required — Prefecture or city code from byoinnavi/areas (examples: "13", "13104")
• specialty string nullable — Specialty code from byoinnavi/specialties (examples: "000")
• features array nullable — Facility features; all must match (one of: "online_consultation", "online_booking", "night_consultation", "holiday_consultation", "female_doctor", "smartphone_insurance_card", "inpatient_care", "kids_space", "credit_card", "parking", "english", "foreign_language", "large_hospital", "cancer_care_base_hospital", "home_care", "dpc_hospital", "accessibility", "infection_prevention", "second_opinion_consultation", "second_opinion_referral", "local_cooperation"; examples: ["female_doctor","credit_card"])
• keyword string nullable — Free-text keyword (examples: "内視鏡"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 1500)

Response

• @type string (default: "ByoinnaviClinicCard")
• id string required
• url string required
• facility_type string required
• name string nullable
• is_verified boolean nullable
• rating number nullable
• rating_count integer nullable
• review_count integer nullable
• prefecture string nullable
• city string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• stations array (default: [])
  • @type string (default: "ByoinnaviStation")
  • id string nullable
  • name string required
• phone string nullable
• specialties array (default: [])
• images array (default: [])
• hours array (default: [])
  • @type string (default: "ByoinnaviHours")
  • day string required
  • periods array (default: [])
• hours_note string nullable
• closed_days string nullable
• reserve_links array (default: [])
  • @type string (default: "ByoinnaviCardLink")
  • label string nullable
  • url string nullable
  • phone string nullable
• review_snippets array (default: [])

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 — Byoinnavi serves no facility 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.