POST /api/youapply/programs/search
Price: 10 credits
Search university programmes on YouApply by keywords, destination country, university, degree level, length, study format and delivery, ordered by university rank or by fee.
Lists study-abroad programmes with fees, length, level and university. Pass a result `alias` to youapply/programs for entry and English requirements and the full programme page.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)count integer required — Max number of programmes to return (min: 1; max: 1500)keywords string nullable — Words matched against the programme (examples: "pharmacy", "data science"; minLength: 1)countries array nullable — Destination countries (one of: "australia", "canada", "cyprus", "egypt", "georgia", "germany", "ireland", "jordan", "malaysia", "new-zealand", "poland", "saudi-arabia", "spain", "turkey", "united-kingdom", "united-states-of-america"; minItems: 1)university string nullable — University name from its YouApply URL, or its page URL (examples: "curtin-university")level string nullable — Degree level (one of: "phd-philosophy-doctorate", "master-by-research", "master-by-course-work", "graduate-diploma", "graduate-certificate", "bachelor", "associate-diploma", "diploma", "certificate", "professional-doctorates", "advanced-diploma", "foundation", "career-based-vocational", "presessional", "non-award-study", "higher-doctorate")duration string nullable — Programme length (one of: "lessThanTwo", "two", "twoAndAHalf", "three", "threeAndAHalf", "four", "fourAndAHalf")study_format string nullable — Full-time or part-time study (one of: "full-time", "part-time", "full-time-part-time")delivery string nullable — On campus, online or mixed delivery (one of: "on-campus", "online", "mix")sort string nullable — Result order (one of: "rank", "lowest-tuition-fee", "highest-tuition-fee", "lowest-application-fee", "highest-application-fee")@type string (default: "YouapplyProgram")id string requiredname string nullablealias string nullableurl string nullablelevel string nullablelevel_alias string nullablestudy_mode string nullabledeliveries arraycollege string nullabledisciplines array@type string (default: "YouapplyDiscipline")name string nullablealias string nullableabout string nullableoverview string nullablestart_at integer nullabledeadline_at integer nullableduration_value number nullableduration_unit string nullableduration_text string nullabletuition_fee number nullabletuition_fee_period string nullablecurrency string nullabletuition_fee_usd number nullabletuition_fee_usd_listed number nullableapplication_fee number nullableapplication_fee_usd number nullableqs_world_rank integer nullableoption_count integer nullableis_sponsored boolean nullableis_apply_available boolean nullableis_saudi_scholarship_accredited boolean nullablesource_url string nullableapply_url string nullableuniversity object nullable@type string (default: "YouapplyProgramUniversity")name string nullablealias string nullableimage string nullablecover string nullablerank_name string nullablerank_value integer nullablecountry object nullable@type string (default: "YouapplyCountry")name string nullablealias string nullableflag string nullablecity object nullable@type string (default: "YouapplyCity")name string nullablealias string 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 — The entity was not found, or a precondition failed 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.