POST /api/studiekeuze123/studies/search
Price: 5 credits
Search the studies of Dutch higher education on Studiekeuze123 — a study groups the programmes of one subject and level across institutions — by keyword, level, broad and narrow field. Each study comes with its description, professions and every programme in it with its degree, study load, study forms, admission rules, address and accreditation report.
Studies come in name order. Each programme in `programs` carries its programme `id` for studiekeuze123/programs; studiekeuze123/studies adds the institution of every programme.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)count integer required — Max number of studies to return (min: 1; max: 1000)keyword string nullable — Free-text search over studies (examples: "Rechten", "Psychologie"; minLength: 1)types array — Study levels; several are combined with OR (default: []; one of: "Hbo associate degree", "Hbo bachelor", "Hbo master", "Wo bachelor", "Wo master")specializations array — Broad fields of study; several are combined with OR (default: []; one of: "Aarde en Milieu", "Economie en Bedrijf", "Exact en Informatica", "Gedrag en Maatschappij", "Gezondheid", "Interdisciplinair", "Kunst en Cultuur", "Onderwijs en Opvoeding", "Recht en Bestuur", "Taal en Communicatie", "Techniek")fields_of_study array — Narrow fields of study as Studiekeuze123 writes them; several are combined with OR (default: []; examples: ["recht","geschiedenis, archeologie"])sort_order string — Direction of the name order (default: "asc"; one of: "asc", "desc")@type string (default: "Studiekeuze123Study")id string requiredalias string nullablename string nullableurl string nullablestudy_type string nullablespecialization string nullablefield_of_study string nullablesummary string nullabledescription string nullableprofessions array (default: [])program_count integer nullableprograms array (default: [])@type string (default: "StudyProgram")id string requiredalias string nullablename string nullablemarketing_name string nullablemarketing_name_english string nullablemarketing_name_german string nullablename_english string nullableurl string nullabletitle string nullableprogram_type string nullablespecialization string nullablefunding string nullableis_full_time boolean nullableis_part_time boolean nullableis_dual boolean nullableis_joint_degree boolean nullableis_small_scale_intensive boolean nullablestudy_load_credits integer nullablehovi_id string nullablelocation_id string nullablestreet string nullablepostal_code string nullablecity string nullableadmission_havo string nullableadmission_vwo string nullableadmission_mbo string nullableadditional_requirements_havo string nullableadditional_requirements_vwo string nullableaccreditation_report_url string nullabletuition_fee_url string nullableinstitution 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 nullablelocation object nullable@type string (default: "Location")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 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 — The entity was not found, or a precondition failed 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.