POST /api/qs/programmes
Price: 20 credits
Read one QS programme profile by its numeric id or page address
Reads one QS programme by its numeric id (the `id` /qs/programmes/search returns) or its programme address, and returns its overview text, admission requirements, starting months and tuition alongside the degree, level, subject, mode and duration. The institution's QS stars, rank, subscription tier and fees list come from /qs/programmes/search. `gallery_images` and `gallery_videos` list the programme's photo and video media. A programme address is accepted whole, tracking parameters and fragment included. `university_programme_ids` lists the ids of the programmes of the same university, so one call enumerates a university's programmes.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)programme string required — The programme to read: its numeric QS id (nid) or the address of its QS programme page. (examples: "3157605", "https://www.topuniversities.com/universities/university-bristol/postgrad/msc-development-security"; minLength: 1)@type string (default: "QsProgrammeProfile")id string requiredname string requiredurl string nullableuniversity_name string nullableuniversity_url string nullabledegree string nullablestudy_level string nullablestudy_level_category string nullablesubject string nullablestudy_mode string nullablecourse_mode string nullableduration string nullableduration_months integer nullabletuition_fee integer nullabletuition_fee_currency string nullabletuition_fee_domestic integer nullabletuition_fee_domestic_currency string nullabledescription string nullablecampus_location string nullableadditional_campuses_count integer nullablestarting_months array (default: [])application_deadline_date integer nullableadmission_requirements string nullablefaq array (default: [])@type string (default: "QsProgrammeFaqEntry")question string requiredanswer string requiredimage string nullablegallery_images array (default: [])gallery_videos array (default: [])university_programme_ids array (default: [])422 — 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 — Programme not found 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.