/the/institutions/profile

POST /api/the/institutions/profile

Price: 10 credits

Get a Times Higher Education institution profile with its multi-year rank history

How to use it

This is the time-series call: one institution, one edition per year in `editions`, each carrying the overall and per-subject-area rank bands with their pillar breakdown and that year's student statistics. `/the/rankings/table` gives the same institution for a single edition alongside its peers, so use that to compare institutions and this to follow one over time. `impact_editions` is a separate sustainability series and is carried by most but not all institutions. Pass the `alias` a table row returned; a bare institution name will not resolve.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• institution string required — The institution's alias, or the full address of its Times Higher Education profile page. The alias is what `/the/rankings/table` returns as `alias`. (examples: "university-oxford", "https://www.timeshighereducation.com/world-university-rankings/tsinghua-university"; minLength: 1)

Response

• @type string (default: "TheInstitution")
• id string required
• alias string required
• profile_url string required
• name string required
• description string nullable
• country string nullable
• address object nullable
  • @type string (default: "TheInstitutionAddress")
  • street string nullable
  • city string nullable
  • region string nullable
  • postal_code string nullable
  • country string nullable
• is_premium boolean (default: false)
• subjects array (default: [])
  • @type string (default: "TheInstitutionSubject")
  • key string required
  • name string nullable
  • label string nullable
  • code string nullable
  • image string nullable
• editions array (default: [])
  • @type string (default: "TheInstitutionEdition")
  • year integer required
  • name string nullable
  • student_count integer nullable
  • students_per_staff number nullable
  • international_student_percent number nullable
  • female_student_percent number nullable
  • areas array (default: [])
    • @type string (default: "TheInstitutionAreaResult")
    • key string required
    • name string nullable
    • rank_display string nullable
    • rank_from integer nullable
    • rank_to integer nullable
    • is_joint_ranked boolean (default: false)
    • score_from number nullable
    • score_to number nullable
    • pillars array (default: [])
• impact_editions array (default: [])
  • @type string (default: "TheInstitutionEdition")
  • year integer required
  • name string nullable
  • student_count integer nullable
  • students_per_staff number nullable
  • international_student_percent number nullable
  • female_student_percent number nullable
  • areas array (default: [])
    • @type string (default: "TheInstitutionAreaResult")
    • key string required
    • name string nullable
    • rank_display string nullable
    • rank_from integer nullable
    • rank_to integer nullable
    • is_joint_ranked boolean (default: false)
    • score_from number nullable
    • score_to number nullable
    • pillars array (default: [])
• downloads array (default: [])
  • @type string (default: "TheInstitutionDownload")
  • name string nullable
  • file_url string required

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 — Institution profile 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.