POST /api/studyportals/programs
Price: 10 credits
Get a Studyportals study programme by id or URL
Get one study programme by Studyportals id or page URL with the full programme page: description, fees, intakes, admission requirements and scholarships. Programme ids come from the programme search.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)program string required — Studyportals programme id or programme page URL. (examples: "59830", "https://www.bachelorsportal.com/studies/59830/electrical-and-electronic-engineering.html"; minLength: 1)@type string (default: "StudyportalsProgram")id string requiredname string requiredurl string requiredlevel string nullabledegree_name string nullabledescription string nullableoverview string nullableprogram_structure string nullablewebsite_url string nullabledelivery_modes array (default: [])is_full_time boolean nullableis_part_time boolean nullabledurations array (default: [])@type string (default: "StudyportalsProgramDuration")study_pace string nullableamount integer nullableperiod string nullabletuition_fees array (default: [])@type string (default: "StudyportalsProgramFee")target string nullableamount number nullablecurrency string nullableunit string nullabletuition_details string nullableintakes array (default: [])@type string (default: "StudyportalsIntake")start_date integer nullabledeadlines array (default: [])languages array (default: [])credits array (default: [])@type string (default: "StudyportalsCredit")system string nullableamount number nullabledisciplines array (default: [])@type string (default: "StudyportalsDiscipline")id string requiredname string nullableparent_id string nullableuniversity object nullable@type string (default: "StudyportalsProgramUniversity")id string requiredname string nullableurl string nullablelocations array (default: [])@type string (default: "StudyportalsProgramUniversityLocation")city string nullablecountry string nullablecountry_code string nullablereview_rating object nullable@type string (default: "StudyportalsReviewRating")average number nullablestar_rating number nullablereview_count integer nullablehas_enough_reviews boolean nullableparent_university_id string nullableparent_university_name string nullableacademic_requirements array (default: [])@type string (default: "StudyportalsTestRequirement")test string requiredvariant string nullablescore string nullableacademic_requirements_text string nullableenglish_requirements array (default: [])@type string (default: "StudyportalsTestRequirement")test string requiredvariant string nullablescore string nullableother_requirements string nullableliving_cost object nullable@type string (default: "StudyportalsProgramLivingCost")city string nullablecountry string nullablemin number nullablemax number nullablecurrency string nullableperiod string nullablescholarships array (default: [])@type string (default: "StudyportalsScholarship")id string nullablename string requiredurl string nullabledescription string nullableamount number nullablecurrency string nullablefunder 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 programme with this id. 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.