POST /api/studiekeuze123/institutions
Price: 20 credits
Get one Dutch university or university of applied sciences from Studiekeuze123 by its alias or page URL: BRIN code, type, staff, description, website and every location with its address, contacts, student count, student ratings of the location and the programmes taught there.
One institution by the `alias` studiekeuze123/institutions/search returns. Each location lists the ids of its programmes; pass one to studiekeuze123/programs for the full programme.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)institution string required — Studiekeuze123 institution alias or institution page URL (examples: "avans-hogeschool", "https://www.studiekeuze123.nl/onderwijsinstellingen/avans-hogeschool")@type string (default: "Studiekeuze123Institution")id string nullablealias string requiredname string nullablename_english string nullableurl string nullablebrin string nullableshort_code string nullableinstitution_type string nullablestaff_count integer nullabledescription string nullablewebsite string nullablelocation_count integer nullableprogram_count integer nullablelocations array (default: [])@type string (default: "InstitutionLocation")id string nullablealias string nullablename string nullableis_main_location boolean nullablestreet string nullablepostal_code string nullabletown string nullableprovince string nullablephone string nullableemail string nullablewebsite string nullabledescription string nullablestudent_count integer nullablesurvey_year integer nullablehovi_id string nullablelatitude number nullablelongitude number nullableclarity_support_rating number nullableinformation_satisfaction_rating number nullablefacilities_satisfaction_rating number nullableunderstanding_rating number nullablehandling_rating number nullableunderstanding_percentages array (default: [])handling_percentages array (default: [])building_accessibility_percentages array (default: [])website_accessibility_percentages array (default: [])digital_environment_accessibility_percentages array (default: [])material_accessibility_percentages array (default: [])institution object nullable@type string (default: "InstitutionRef")id string nullablealias string nullablename string nullablename_english string nullablebrin string nullableshort_code string nullableinstitution_type string nullablestaff_count integer nullabledescription string nullableurl string nullableurl string nullableprogram_count integer nullableprograms array (default: [])@type string (default: "LocationProgram")id string requiredname string nullableprogram_type string nullableurl string nullable422 — 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 has that alias on Studiekeuze123 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.