POST /api/studyinsaudi/institutions/search
Price: 1 credit
Search the higher-education institutions listed on Study in Saudi, the Saudi Ministry of Education's portal for international students, by name, type and region. Each institution carries its English and Arabic names, type, city, region, programme and college counts, world ranking, logo and cover image
With no filter it lists every institution on the portal. Pass a returned id to studyinsaudi/institutions for the profile and programme list, or as institution to studyinsaudi/programs/search.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)keyword string nullable — Words to look for in the institution name (examples: "King Saud"; minLength: 1)institution_type string nullable — Institution type (one of: "Government University", "Private University", "Academy or Institute"; examples: "Private University")region string nullable — Saudi region of the institution (one of: "Al Bahah", "Al Jawf", "Asir", "Eastern Province", "Hail", "Jazan", "Madinah", "Makkah", "Najran", "Northern Borders", "Qassim", "Riyadh", "Tabuk"; examples: "Riyadh")count integer required — Max number of institutions to return (min: 1; max: 100)@type string (default: "StudyinsaudiInstitution")id string requiredname string requiredname_ar string nullableacronym string nullableinstitution_type string nullablecity string nullablecity_ar string nullableregion string nullableregion_ar string nullablecollege_count integer nullableprogram_count integer nullablestudent_count integer nullableworld_ranking string nullableimage string nullablecover string nullableurl 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 institution on the portal matches these 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.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.