POST /api/studyportals/universities
Price: 20 credits
Get a Studyportals university by id or URL
Get one university by Studyportals id or page URL, with its programme counts per level, rankings, ratings, website, social links, campuses, student numbers and descriptive sections.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)university string required — Studyportals university id or university page URL. (examples: "11506", "https://www.mastersportal.com/universities/17/university-of-helsinki.html"; minLength: 1)@type string (default: "StudyportalsUniversity")id string requiredname string requiredurl string nullablesummary string nullableimage string nullablecity string nullablearea_code string nullablecountry_code string nullablecountry string nullablecampus_count integer nullablecampus_country_codes array (default: [])has_online boolean nullablehas_on_campus boolean nullablehas_blended boolean nullableis_public_funded boolean nullableis_non_profit boolean nullableis_for_profit boolean nullableis_premium boolean nullableglobal_rank integer nullabletop_percent number nullablediscipline_ranks array (default: [])@type string (default: "StudyportalsDisciplineRank")discipline object nullable@type string (default: "StudyportalsDiscipline")id string requiredname string nullableparent_id string nullableposition integer nullablebachelor_count integer nullablemaster_count integer nullablephd_count integer nullableshort_course_count integer nullabledistance_learning_count integer nullablereview_rating object nullable@type string (default: "StudyportalsReviewRating")average number nullablestar_rating number nullablereview_count integer nullablehas_enough_reviews boolean nullabledescription string nullablewebsite_url string nullablesocial_urls array (default: [])latitude number nullablelongitude number nullablecampuses array (default: [])@type string (default: "StudyportalsCampus")campus_type string nullablecity string nullablecountry string nullableinstitution_type string nullablestudent_count integer nullableinternational_student_count integer nullablefemale_student_count integer nullableacademic_staff_count integer nullableonline_course_count integer nullablepage_program_counts object nullable@type string (default: "StudyportalsPageProgramCounts")bachelor_count integer nullablemaster_count integer nullablephd_count integer nullableshort_course_count integer nullabledistance_learning_count integer nullablewritten_review_count integer nullablerating_histogram array (default: [])@type string (default: "StudyportalsStarCount")stars integer requiredreview_count integer nullableshare_percent number nullablecategory_ratings array (default: [])@type string (default: "StudyportalsCategoryRating")name string requiredscore number nullablehas_award boolean (default: false)reviews array (default: [])@type string (default: "StudyportalsStudentReview")title string nullabletext string nullablerating number nullableauthor_name string nullablestudy_start_date integer nullablestudy_end_date integer nullableposted_date integer nullablecountry_rank integer nullablecountry_ranked_count integer nullablerankings array (default: [])@type string (default: "StudyportalsRanking")name string requiredpublisher string nullableposition string nullablehistory array (default: [])@type string (default: "StudyportalsRankingYear")year integer nullableposition integer nullabletop_reasons array (default: [])sections array (default: [])@type string (default: "StudyportalsTextSection")title string nullabletext string required422 — 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 university 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.