POST /api/dges/programs/search
Price: 20 credits
Search the institution/course pairs of Portugal's national higher-education access guide (DGES) by course name, institution type, institution, course, CNAEF study area, district and degree. Each pair carries its id, institution and course codes and names, institution type, degree and vacancies for the coming academic year
With no filter it lists every pair in the guide. Pass a returned id to dges/programs for exams, minimum scores and placement statistics. Names are in Portuguese; keyword ignores accents and case.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)keyword string nullable — Words that must all appear in the course name (examples: "Medicina"; minLength: 1)institution_type string nullable — Institution type (one of: "Ensino Superior Público Universitário", "Ensino Superior Público Politécnico", "Ensino Superior Público Militar e Policial", "Ensino Superior Privado Universitário", "Ensino Superior Privado Politécnico"; examples: "Ensino Superior Público Politécnico")institution string nullable — DGES institution code (examples: "0300"; minLength: 1)course string nullable — DGES course code (examples: "9813", "L149"; minLength: 1)area string nullable — CNAEF study area (one of: "Formação de Professores/Formadores e Ciências da Educação", "Artes", "Humanidades", "Ciências Sociais e do Comportamento", "Informação e Jornalismo", "Ciências Empresariais", "Direito", "Ciências da Vida", "Ciências Físicas", "Matemática e Estatística", "Informática", "Engenharia e Técnicas Afins", "Indústrias Transformadoras", "Arquitetura e Construção", "Agricultura, Silvicultura e Pescas", "Ciências Veterinárias", "Saúde", "Serviços Sociais", "Serviços Pessoais", "Serviços de Transporte", "Proteção do Ambiente", "Serviços de Segurança", "Desconhecido ou não especificado"; examples: "Saúde")district string nullable — District or autonomous region of the institution (one of: "Aveiro", "Beja", "Braga", "Bragança", "Castelo Branco", "Coimbra", "Évora", "Faro", "Guarda", "Leiria", "Lisboa", "Portalegre", "Porto", "Santarém", "Setúbal", "Viana do Castelo", "Vila Real", "Viseu", "R. A. Açores", "R. A. Madeira"; examples: "Lisboa")degree string nullable — Degree, as dges/programs prints it (one of: "Licenciatura - 1º ciclo", "Mestrado Integrado", "Preparatórios de licenciatura - 1º ciclo", "Preparatórios de Mestrado Integrado"; examples: "Mestrado Integrado")count integer required — Max number of pairs to return (min: 1; max: 2000)@type string (default: "DgesProgramListing")id string requiredinstitution_id string requiredcourse_id string requiredname string nullableinstitution_name string nullableinstitution_type string nullabledegree string nullablevacancies integer 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 — No pair in the current access guide matches these filters 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.