POST /api/studiekeuze123/programs
Price: 10 credits
Get one Dutch higher-education programme from Studiekeuze123 by its id or page URL: the full programme record of the search plus duration, teaching languages, overall student rating, statutory tuition per academic year, every start moment with its application deadline and the labour-market figures of its study (most chosen professions or masters, time to a job, salary, job satisfaction), the institution's programme count and the number of students in its municipality.
One programme by the `id` studiekeuze123/programs/search returns. Labour-market figures describe the study nationwide, not this institution alone. Values are in Dutch as the site writes them.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)program string required — Studiekeuze123 programme id or programme page URL (examples: "3", "https://www.studiekeuze123.nl/opleidingen/3-hbo-rechten-avans-hogeschool-hbo-bachelor")@type string (default: "Studiekeuze123Program")id string requiredalias string nullablename string nullablemarketing_name string nullablename_english string nullableurl string nullableprogram_type string nullablespecialization string nullablefunding string nullableis_honours boolean nullableis_small_scale_intensive boolean nullableis_joint_degree boolean nullableadmission_havo string nullableadmission_vwo string nullableadmission_mbo string nullableadditional_requirements_havo string nullableadditional_requirements_vwo string nullableadmission_profiles array (default: [])numerus_fixus array (default: [])@type string (default: "NumerusFixus")id string nullablestudy_form string nullableyear integer nullableplace_count integer nullableapplication_deadline_at integer nullablelanguage string nullableattempt_count integer nullablewebsite string nullableopen_day_count integer nullableprofessions 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 nullableawarding_institutions array (default: [])@type string (default: "AwardingInstitution")brin string nullablename string nullableshort_code 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 nullablejoint_degree_locations array (default: [])@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 nullableinstitution_logo string nullableimage string nullablestudy_forms array (default: [])@type string (default: "StudyForm-Output")id string nullablename string nullablehovi_id string nullableyear integer nullabledata_source_year integer nullabledescription string nullabledescription_english string nullabledescription_german string nullablewebsite string nullableadmission_requirements_url string nullableadmission_requirements_url_english string nullablerating number nullablerating_count integer nullablerating_percentages array (default: [])teachers_rating number nullablecontent_rating number nullableguidance_rating number nullablefacilities_rating number nullableexamination_rating number nullableatmosphere_rating number nullableprofession_preparation_rating number nullablestudy_again_rating number nullableinvolvement_rating number nullableenglish_material_rating number nullablecareer_preparation_rating number nullablestudy_pressure_rating number nullablestudy_pressure_way_too_low_percentage number nullablestudy_pressure_too_low_percentage number nullablestudy_pressure_right_percentage number nullablestudy_pressure_too_high_percentage number nullablestudy_pressure_way_too_high_percentage number nullablestudent_count integer nullablefirst_year_student_count integer nullablefirst_year_female_percentage number nullablesecond_year_retention_percentage number nullablediploma_any_percentage number nullablediploma_program_percentage number nullablecontinues_studying_percentage number nullableforeign_student_percentage number nullablestudy_advice_credits integer nullableis_study_advice_binding boolean nullablestudy_advice_months integer nullablevariants array (default: [])@type string (default: "Variant")id string nullablename string nullablename_english string nullablevariant_type string nullableurl string nullabledescription string nullabledescription_english string nullablehovi_id string nullableopen_days array (default: [])@type string (default: "OpenDay")id string nullablename string nullableopen_day_type string nullabledescription string nullableavailability string nullableis_online boolean nullablestarts_at integer nullableends_at integer nullableurl string nullablecity string nullablelatitude number nullablelongitude number nullablelocations array (default: [])duration_months integer nullablelanguages array (default: [])overall_rating number nullableoverall_rating_count integer nullabletuition_fees array (default: [])@type string (default: "TuitionFee")academic_year integer nullableamount number nullablecurrency string nullablefee_type string nullablestudy_form string nullablestart_moments array (default: [])@type string (default: "StartMoment")study_form string nullablestarts_at integer nullableapplication_deadline_at integer nullablelabel string nullablelabour_market object nullable@type string (default: "LabourMarket")top_professions array (default: [])@type string (default: "Profession")name string requiredpercentage number nullabletop_masters array (default: [])@type string (default: "MasterChoice")name string requiredstudent_count integer nullablepercentage number nullablejob_prospects string nullablemonths_to_job number nullablepermanent_contract_percentage number nullablejob_in_field_percentage number nullablejob_at_level_percentage number nullablestarting_salary number nullablelevel_average_starting_salary number nullableweekly_working_hours number nullableself_employed_percentage number nullablejob_satisfaction_rating number nullablecareer_satisfaction_rating number nullableinstitution_program_count integer nullablemunicipality string nullablemunicipality_student_count integer 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 programme has that id 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.