POST /api/dges/programs
Price: 1 credit
Get one institution/course pair from Portugal's national higher-education access guide (DGES): course and institution names, degree, CNAEF study area, duration, ECTS, institution type, competition, vacancies for the coming academic year, entrance exams, prerequisites, minimum scores, the application-score formula, regional and preferential quotas, the institution's address and contacts, and applicants, placements and placed-candidate scores per year and phase for the last three years
Pass a pair id from dges/programs/search. Entrance exams and minimum scores are published for nearly every pair; the Universidade Católica Portuguesa ones point to the institution instead; prior-year statistics hold full per-phase data for most public pairs and vacancies only for most private ones. Values are in Portuguese as the guide prints them.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)program string required — Institution/course pair code, or its page URL in the DGES access guide (examples: "0300/9002", "https://www.dges.gov.pt/guias/detcursopi.asp?codc=9002&code=0300"; minLength: 1)@type string (default: "DgesProgram")id string requiredinstitution_id string requiredcourse_id string requiredname string nullableinstitution_name string nullabledegree string nullablecnaef_area_code string nullablecnaef_area string nullableduration string nullableects integer nullableinstitution_type string nullablecompetition string nullablecompetition_note string nullableacademic_year string nullablevacancies integer nullableaddress string nullablepostal_code string nullablecity string nullablelatitude number nullablelongitude number nullablephone string nullablefax string nullablewebsite string nullableemail string nullableemails array (default: [])prerequisite_type string nullableprerequisite_groups array (default: [])@type string (default: "DgesCodedName")code string requiredname string nullableentrance_exam_requirement string nullableentrance_exams array (default: [])@type string (default: "DgesCodedName")code string requiredname string nullableminimum_scores array (default: [])@type string (default: "DgesWeightedComponent")component string requiredvalue number nullableminimum_scores_note string nullableformula array (default: [])@type string (default: "DgesWeightedComponent")component string requiredvalue number nullableformula_note string nullableregional_preference_percent number nullableregional_preference_districts array (default: [])preferential_access_percent number nullablepreferential_access_courses array (default: [])@type string (default: "DgesCodedName")code string requiredname string nullablenotes string nullablestatistics array (default: [])@type string (default: "DgesStatistic")year integer requiredphase integer nullablevacancies integer nullableapplicant_count integer nullablefemale_applicant_count integer nullablemale_applicant_count integer nullablefirst_choice_applicant_count integer nullableplaced_count integer nullablefemale_placed_count integer nullablemale_placed_count integer nullablefirst_choice_placed_count integer nullableplaced_mean_application_score number nullableplaced_mean_exam_score number nullableplaced_mean_secondary_score number nullablelast_placed_application_score number nullablereport_url string nullableadditional_sections array (default: [])@type string (default: "DgesSection")title string requiredtext string nullableinfocursos_url string nullableurl string required422 — 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 — This institution/course pair is not in the current access guide 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.