POST /api/qs/programmes/search
Price: 5 credits
Search the QS programme directory with its fees, duration and attributes
Reads the QS programme directory, one rich row per degree programme with its fees, duration, attributes and the institution's world rank. Filter by `study_level`, `country` (ISO-2) or `subject` (the subject id /qs/rankings/filters returns); pass at least one to narrow the result. There is no free-text search here. Rows come best world rank first. `rank` is the institution's world rank as QS publishes it (a number, a tie such as `=273` or a band such as `711-720`); `regions`, `countries` and `cities` list one value per campus. `institution_core_id` joins a programme to its QS ranking row. A null `rank` means the institution is unranked, and `attributes` carries the level, mode, subject, fee and duration as QS labels them.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)study_level string nullable — Keep only programmes at this level of study. (one of: "bachelors", "masters", "mba", "phd")country string nullable — Keep only programmes in this country, given as its ISO 3166-1 alpha-2 code. (examples: "nz", "gb"; minLength: 2; maxLength: 2)subject string nullable — Keep only programmes in this subject, given as the subject id that /qs/rankings/filters returns beside its name. (examples: "465"; minLength: 1)count integer required — Max number of programmes to return. (examples: 50; min: 1; max: 500)@type string (default: "QsProgramme")id string requiredname string requiredurl string nullableinstitution_core_id string nullableuniversity_name string nullableuniversity_url string nullableuniversity_website string nullableuniversity_email string nullableregions array (default: [])countries array (default: [])cities array (default: [])study_destinations array (default: [])campuses array (default: [])subject_ids array (default: [])study_level string nullablemba_program_type string nullableduration_months integer nullabletuition_fees array (default: [])stars string nullablerank string nullableimage string nullablegallery_images array (default: [])gallery_videos array (default: [])attributes object nullable@type string (default: "QsProgrammeAttributes")study_level string nullablestudy_mode string nullablecourse_intensity string nullablesubject string nullableduration string nullablescholarships string nullablestart_date string nullableapplication_deadline string nullablefee_amount integer nullablefee_currency string nullablesubscription_tier 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 programmes available 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.