POST /api/studyinjapan/schools
Price: 10 credits
Get one Japanese school from Study in Japan by its code: names in Japanese, English and kana, ownership, prefectures, photos, introduction, scholarship, tuition reduction, dormitory, prayer room and religious meal availability, every programme with its id and degree, website and brochure links
The en page exists only for schools that publish an English profile; language ja reaches every school. Each entry in `programmes` carries the `id` and `programme_type` studyinjapan/programmes takes.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)school string required — Study in Japan school code or school page URL (examples: "303081", "https://www.studyinjapan.go.jp/en/search-for-schools/detail.php?lang=en&school_code=305027")language string — Page language: en, or ja for the full Japanese catalogue; a pasted URL sets it (default: "en"; one of: "en", "ja")@type string (default: "StudyinjapanSchool")id string requiredname string nullablename_en string nullablename_kana string nullableownership string nullableprefectures array nullableimage string nullableimages array nullableupdated_date integer nullablewebsite string nullablesections array nullable@type string (default: "StudyinjapanSection")title string nullablegroup string nullabletext string nullabledetails array nullable@type string (default: "StudyinjapanDetail")label string nullablevalue string nullabledetails array nullableprogrammes array nullable@type string (default: "StudyinjapanSchoolProgramme")id string requiredprogramme_type string requiredname string nullabledegree string nullableurl string requiredprogramme_count integer nullablecontact object nullable@type string (default: "StudyinjapanContact")email string nullabledetails array nullable@type string (default: "StudyinjapanDetail")label string nullablevalue string nullabledetails array nullablelinks array nullable@type string (default: "StudyinjapanLink")name string nullableurl string requiredurl string required422 — 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 — No school is listed under this code in the requested language 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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.