POST /api/hochschulkompass/institutions
Price: 10 credits
Get one German university from Hochschulkompass by its id: leadership, student numbers, type, doctorate and habilitation rights, founding year, profile texts, addresses, contact offices with people, extra campuses and application deadlines
Values are in German as the site publishes them. Addresses, contact offices and deadlines sit in `sections`, each entry a label and value under its office or heading.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)institution string required — Hochschulkompass institution id or its page URL (examples: "101", "https://www.hochschulkompass.de/hochschulen/hochschulsuche/detail/all.html?tx_szhrksearch_pi1%5Bhslauf%5D=101")@type string (default: "HochschulkompassInstitution")id string requiredurl string requiredname string requiredimage string nullablewebsite_url string nullablehead string nullablestudent_count integer nullablestudent_count_term string nullableinstitution_type string nullablehas_doctorate_right boolean nullabledoctorate_right string nullablehas_habilitation_right boolean nullableownership string nullablefounded_year integer nullablestate string nullablequote string nullablequote_author string nullablequote_author_role string nullablevideo_url string nullableprofile_url string nullableresearch_map_url string nullablesocial_links array (default: [])profile_blocks array (default: [])@type string (default: "HochschulkompassProfileBlock")kind string nullabletitle string nullabletext string nullablehighlights array (default: [])quote string nullablequote_author string nullablequote_author_role string nullableimages array (default: [])sections array (default: [])@type string (default: "HochschulkompassSection")key string requiredtitle string nullableentries array (default: [])@type string (default: "HochschulkompassEntry")group string nullablesubgroup string nullableperson string nullablelabel string nullablevalue string nullableurl string nullableemail string nullablestart_date integer nullableend_date integer 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 institution is published under 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.