/qs/rankings/filters

POST /api/qs/rankings/filters

Price: 10 credits

List the years, study levels, subjects and places one QS ranking table can be sliced by

How to use it

Call this before /qs/rankings/table whenever a filter value or another year is needed: the table's `subject` takes the ids returned here, `city` and `region` the names, `country` the ISO-2 codes, and `editions` carries the page address of each year this catalogue names. The catalogue is not exhaustive: a year it omits can still be read by passing that year's own page to the table, for example '/world-university-rankings/2023'. The catalogue is per table, so a subject ranking returns its own narrower set.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• ranking string — Which ranking table to read: the path or full address of a QS ranking page, or the numeric table id. Every published year and subject has its own page, and /qs/rankings/filters lists the pages of the years it knows about, which are not always all of them. (default: "/world-university-rankings"; examples: "/world-university-rankings", "/world-university-rankings/2026", "/university-subject-rankings/computer-science-information-systems", "4153156"; minLength: 1)

Response

• @type string (default: "QsRankingFilters")
• id string required
• ranking_url string nullable
• editions array (default: [])
  • @type string (default: "QsRankingEdition")
  • year string required
  • page_url string nullable
  • is_current boolean (default: false)
• study_levels array (default: [])
  • @type string (default: "QsFilterOption")
  • id string required
  • name string required
• subjects array (default: [])
  • @type string (default: "QsFilterOption")
  • id string required
  • name string required
• regions array (default: [])
  • @type string (default: "QsRegionOption")
  • name string required
  • countries array (default: [])
    • @type string (default: "QsCountryOption")
    • name string required
    • code string nullable
    • cities array (default: [])

Errors

• 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 — Ranking page 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.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-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.