POST /api/studyportals/programs/search
Price: 10 credits
Search Studyportals study programmes
Search study programmes of every level (Bachelors, Masters, PhDs, short courses) worldwide by text, discipline, country, degree type, attendance, duration, tuition and start date. Each result carries the university id for the universities endpoint and the programme id for the programme detail endpoint.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)count integer required — Max number of results (min: 1; max: 10000)text string nullable — Free-text search over programmes. (examples: "data science"; minLength: 1)levels array — Study levels, matched as any-of. (default: []; one of: "bachelor", "master", "phd", "short"; examples: ["master"])degree_types array — Degree types, matched as any-of. (default: []; one of: "bsc", "msc", "ba", "phd", "ma", "certificate", "mba", "prebachelor", "med", "bba", "postgradcert", "beng", "bfa", "llm", "premaster", "bmus", "mfa", "mphil", "postgraddip", "meng", "mmus", "adiploma", "gdiploma", "llb", "gcertificate", "mph", "mres", "ad", "bcom", "bed", "mpa", "mat", "language", "bsw", "doct", "dba", "mlitt", "mim", "ap"; examples: ["msc","ma"])disciplines array — Disciplines by id or name, matched as any-of; the ids are the `disciplines[].id` values results carry. (default: []; examples: ["Business & Management"], ["24"])countries array — Countries where the programme is taught, ISO 3166-1 alpha-2. (default: []; examples: ["NL","DE"])main_location_countries array — Countries of the programme's main location, ISO 3166-1 alpha-2. (default: []; examples: ["NL"])regions array — World regions, matched as any-of. (default: []; one of: "europe", "asia", "africa", "north_america", "oceania", "south_america"; examples: ["europe"])area_ids array — State or area ids, the `locations[].area_id` values results carry. (default: []; examples: ["3605"])university_ids array — Studyportals university ids. (default: []; examples: ["17"])attendances array — Ways of attending, matched as any-of. (default: []; one of: "online", "on_campus", "blended"; examples: ["online","blended"])study_paces array — Full-time or part-time. (default: []; one of: "full_time", "part_time"; examples: ["part_time"])durations array — Programme length ranges. (default: []; one of: "under_1_month", "from_1_to_3_months", "over_3_months", "under_1_year", "one_year", "one_and_half_years", "under_2_years", "two_years", "over_2_years", "two_and_half_years", "three_years", "three_and_half_years", "four_years", "over_4_years"; examples: ["one_year"])course_formats array — Short-course formats, matched as any-of. (default: []; one of: "academic", "skill", "summer_school", "professional", "winter_school", "conference", "semester"; examples: ["summer_school"])program_types array — Joint, executive or Erasmus programmes. (default: []; one of: "joint", "executive", "erasmus"; examples: ["erasmus"])min_tuition_fee_eur number nullable — Lowest tuition fee, in euros. (min: 0)max_tuition_fee_eur number nullable — Highest tuition fee, in euros. (min: 0)start_date_from integer nullable — Earliest programme start date, unix seconds; only its UTC calendar day is used. (examples: 1811808000; min: 0)start_date_to integer nullable — Latest programme start date, unix seconds; only its UTC calendar day is used. (examples: 1814313600; min: 0)@type string (default: "StudyportalsProgramCard")id string requiredname string requiredurl string nullabledescription string nullablelevel string nullabledegree string nullabledegree_name string nullableis_premium boolean nullableis_fully_online boolean nullableis_online boolean nullableis_on_campus boolean nullableis_blended boolean nullableis_full_time boolean nullableis_part_time boolean nullableuniversity object nullable@type string (default: "StudyportalsUniversityRef")id string requiredname string nullabledisplay_name string nullableurl string nullableuniversity_top_percent number nullablelocation_text string nullablecountry_code string nullablelocations array (default: [])@type string (default: "StudyportalsLocation")text string nullablecity_id string nullablecity string nullablearea_id string nullablearea string nullablecountry_id string nullablecountry_code string nullablecountry string nullabletuition_fees array (default: [])@type string (default: "StudyportalsTuitionFee")target string nullableis_free boolean nullableamount number nullablecurrency string nullableunit string nullableoriginal_amount number nullableoriginal_unit string nullablediscounted_amount number nullableoriginal_discounted_amount number nullableduration object nullable@type string (default: "StudyportalsDuration")amount integer nullableperiod string nullableoriginal_amount integer nullableoriginal_period string nullabledescription string nullabletimings array (default: [])@type string (default: "StudyportalsTiming")target string nullableis_starting_anytime boolean nullableis_applying_anytime boolean nullablestart_date integer nullableis_start_passed boolean nullabledeadline object nullable@type string (default: "StudyportalsDeadline")date integer nullabletarget string nullableis_passed boolean nullabledeadlines array (default: [])@type string (default: "StudyportalsDeadline")date integer nullabletarget string nullableis_passed boolean nullabledisciplines array (default: [])@type string (default: "StudyportalsDiscipline")id string requiredname string nullableparent_id string nullableects_credits number nullablework_experience_years number nullableenglish_scores object nullable@type string (default: "StudyportalsEnglishScores")ielts number nullabletoefl_internet number nullabletoefl_paper number nullablepte number nullableduolingo number nullablecambridge_english number nullableoxford_test_of_english number nullablegpa object nullable@type string (default: "StudyportalsGpa")is_required boolean nullablescale string nullablescore string nullableliving_cost object nullable@type string (default: "StudyportalsLivingCost")min number nullablemax number nullablecurrency string nullableperiod string nullablereview_rating object nullable@type string (default: "StudyportalsReviewRating")average number nullablestar_rating number nullablereview_count integer nullablehas_enough_reviews boolean nullablewebsite_url string nullablecover string nullableuniversity_logo string nullableupdated_at 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 — 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.