# /studyinaustria/programs/search

`POST /api/studyinaustria/programs/search`

Price: 20 credits

Search Austrian degree programmes in the Study in Austria programme database by keyword, field of study, state, study form, programme type, institution, language and stay abroad, returning each programme's full record

## How to use it

Several values in one list filter match any of them; different filters must all match. A programme can sit under more than one field_of_study.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `keyword` (string, nullable) — Words to search for in programmes (examples: "informatik", "economics"; minLength: 1; maxLength: 100)
- `field_of_study` (string, nullable) — Group of fields of study (one of: "art_studies", "engineering_sciences", "humanities", "law", "medicine_healthcare", "natural_sciences", "social_and_economic_sciences", "teacher_training_programmes", "theological_studies"; examples: "engineering_sciences")
- `subfield` (string, nullable) — Field of study inside field_of_study, as it appears in programme URLs (examples: "computer-sciences"; pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$)
- `states` (array) — Austrian federal states (default: []; one of: "burgenland", "carinthia", "lower_austria", "upper_austria", "salzburg", "styria", "tyrol", "vorarlberg", "vienna"; examples: ["vienna","styria"])
- `study_forms` (array) — Study forms (default: []; one of: "full_time", "part_time", "distance"; examples: ["distance"], ["part_time"])
- `program_types` (array) — Programme types (default: []; one of: "bachelor", "diploma", "doctorate", "university_course", "bachelor_professional", "bachelor_continuing_education", "master_course", "master", "master_also_teacher_training", "teacher_training_bachelor", "phd", "extended_programme", "master_professional", "master_continuing_education"; examples: ["bachelor"], ["master","phd"])
- `program_features` (array) — Programme features (default: []; one of: "individually_designed", "licentiate", "university_college_course", "erasmus_mundus", "joint_double_degree", "teacher_training_master"; examples: ["erasmus_mundus"])
- `institution_types` (array) — Kinds of institution (default: []; one of: "university_of_applied_sciences", "university", "university_college_of_teacher_education", "private_university", "private_university_college"; examples: ["university_of_applied_sciences"])
- `languages` (array) — Languages of instruction (default: []; one of: "german", "english", "partly_english", "other"; examples: ["english"])
- `stay_abroad` (array) — Stay abroad requirement (default: []; one of: "recommended", "not_compulsory", "compulsory"; examples: ["compulsory"])
- `institution_ids` (array) — Campus-level institution ids of the programme search form, such as 9 for Wirtschaftsuniversität Wien or 1 for Universität Innsbruck; any other id is rejected (default: []; examples: ["9"], ["1","3"])
- `offset` (integer) — Number of matching programmes to skip (default: 0; examples: 0, 20; min: 0; max: 2550)
- `count` (integer, required) — Max number of programmes to return (min: 1; max: 200)

## Response

### 200 — Successful Response

- `@type` (string) (default: "StudyinaustriaProgram")
- `id` (string, required) — Programme id on studienwahl.at (examples: "2055")
- `url` (string, nullable) — Programme page in English
- `german_url` (string, nullable) — Programme page in German
- `name` (string, nullable) — Programme name in English (examples: "Event Engineering")
- `german_name` (string, nullable) — Programme name in German
- `program_type` (string, nullable) — Programme type (examples: "PhD/Doctoral programme")
- `degree` (string, nullable) — Academic degree awarded (examples: "Bachelor of Engineering, B.Eng")
- `institution` (string, nullable) — Higher education institution name
- `institution_website_url` (string, nullable) — Institution website
- `institution_type` (string, nullable) — Kind of higher education institution, in German (examples: "Universität")
- `fields_of_study` (array) — Groups of fields of study (default: [])
- `duration` (string, nullable) — Duration as published (examples: "6 Semester / 180 ECTS")
- `duration_semesters` (integer, nullable) — Duration in semesters
- `ects_credits` (integer, nullable) — ECTS credits
- `languages` (array) — Languages of instruction (default: [])
- `locations` (array) — Cities where the programme is taught (default: [])
- `stay_abroad` (string, nullable) — Whether a stay abroad is part of the programme (examples: "Recommended")
- `is_full_time` (boolean, nullable) — Offered full-time
- `is_part_time` (boolean, nullable) — Offered alongside employment
- `costs` (string, nullable) — Tuition and student union fees, in German (examples: "ÖH-Beitrag: € 26,20")
- `student_info_url` (string, nullable) — Institution page about the programme
- `german_student_info_url` (string, nullable) — German institution page about it
- `curriculum_url` (string, nullable) — Curriculum document
- `curriculum_publication` (string, nullable) — Where the curriculum was published
- `description` (string, nullable) — Content and focus of the programme, in English
- `german_description` (string, nullable) — Content and focus of the programme, in German
- `field_definition` (string, nullable) — Definition of the field of studies
- `entrance_exams` (string, nullable) — Entrance examinations or admission procedure
- `supplementary_exams` (string, nullable) — Supplementary examinations
- `additional_information` (string, nullable) — Additional information
- `german_institutions` (array) — Higher education institutions offering the programme, as listed in German (default: [])
- `german_institution_website_urls` (array) — Websites of the institutions in german_institutions (default: [])
- `german_curriculum_url` (string, nullable) — Curriculum document, German page
- `german_field_definition` (string, nullable) — Definition of the field of studies, in German
- `german_entrance_exams` (string, nullable) — Entrance examinations or admission procedure, in German (examples: "Nein")
- `german_supplementary_exams` (string, nullable) — Supplementary examinations, in German
- `german_additional_information` (string, nullable) — Additional information, in German

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

The entity was not found, or a precondition failed

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.

