POST /api/hochschulkompass/programs
Price: 20 credits
Get one degree programme from Hochschulkompass by its page URL: degree, study type, standard duration, study forms, teaching languages, study fields, admission requirements, application deadlines, tuition, partner universities and contacts
Values are in German as the site publishes them. Deadlines, contacts and tuition sit in `sections`, each entry a label and value under its heading, with dates also given as unix seconds.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)program string required — Hochschulkompass programme page URL or its link token (examples: "https://www.hochschulkompass.de/studium/studiengangsuche/erweiterte-studiengangsuche/detail/all/studtyp/2/lauf/G6GbuA.html", "G6GbuA")@type string (default: "HochschulkompassProgram")id string requiredlink_token string nullableurl string nullablename string requiredinstitution_name string nullableinstitution_website_url string nullableinstitution_image string nullabledegree string nullabledegree_title string nullablestudy_type string nullablemaster_type string nullableadmission_mode string nullablestandard_duration string nullableduration_semesters integer nullablestudy_forms array (default: [])location string nullablestart_semesters string nullablemain_language string nullableother_languages array (default: [])study_fields array (default: [])@type string (default: "HochschulkompassStudyField")name string requiredarea string nullablearea_url string nullablegroup string nullablegroup_url string nullablefocus_areas string nullabletarget_group string nullabledigital_teaching string nullablenote string nullablewebsite_url string nullableaccreditation_url string nullableranking_url string nullabledetails 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 nullablelinks array (default: [])@type string (default: "HochschulkompassLink")label string nullableurl string requiredsections 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 programme is published under this link token or URL 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.