POST /api/idp/courses/search
Price: 20 credits
Search IDP's study-abroad course catalogue by subject, study level, destination country, university, study mode, annual fee, IELTS score, duration, scholarship and internship availability, with fees, intakes, deadlines and rankings on every course
Subjects and universities take the slugs the site uses in its links (accounting, kingston-university); several values in one filter match any of them. Pass a returned `id` to idp/courses for the description, entry requirements and every intake.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)subjects array — Subject slugs the courses are filed under; an unknown slug answers 422 with the closest accepted slugs (default: []; examples: ["accounting"], ["computer-science","data-science"])study_levels array — Study levels (default: []; one of: "doctorate", "english", "english-language", "foundation", "postgraduate", "pre-degree-vocational", "school", "undergraduate", "university-preparation", "vet")destinations array — Countries the courses are taught in (default: []; one of: "australia", "canada", "ireland", "malaysia", "new-zealand", "united-kingdom", "united-states")universities array — Aliases of the universities offering the courses (`alias` of idp/universities); only universities in IDP's course search are accepted, about 1,430, and an alias outside it answers 422 with the closest accepted aliases (default: []; examples: ["kingston-university"], ["university-of-bath","lancaster-university"])study_modes array — How the course is attended (default: []; one of: "off-campus", "on-campus", "on-campus-with-online-start", "online", "overseas-campus")fee_min number nullable — Lowest annual tuition fee (examples: 5000; min: 0)fee_max number nullable — Highest annual tuition fee (examples: 20000; min: 0)fee_currency string — Currency of fee_min and fee_max (default: "USD"; one of: "USD", "GBP")ielts_min number nullable — Lowest IELTS score required (min: 0; max: 9)ielts_max number nullable — Highest IELTS score required (min: 0; max: 9)duration_min_months integer nullable — Shortest course duration in months (min: 0)duration_max_months integer nullable — Longest course duration in months (min: 0)scholarship_only boolean — Only courses with a scholarship available (default: false)internship_only boolean — Only courses with an internship available (default: false)oip_only boolean — Only courses labelled FastLane, IDP's Offer in Principle route (`is_oip` true); a rare label, 2,836 of 188,821 courses (default: false)sort string nullable — Result order; the site's default order when omitted (one of: "ielts_asc", "ielts_desc", "name_asc", "name_desc", "the_ranking", "intake_date", "fee_asc", "fee_desc", "qs_ranking")count integer required — Max number of courses to return (min: 1; max: 2000)@type string (default: "IdpCourseCard")id string requiredname string requiredurl string requiredsubjects array (default: [])university object nullable@type string (default: "IdpCardUniversity")id string requiredname string nullablealias string nullableimage string nullablestudy_level string nullableielts_score number nullablethe_rankings array (default: [])@type string (default: "IdpYearRank")year integer requiredrank integer requiredcampus_country string nullablenearest_city string nullableintake_date integer nullableapplication_deadline integer nullableannual_fee number nullablecurrency string nullableduration number nullableduration_unit string nullablehas_scholarship boolean nullablehas_internship boolean nullableis_oip boolean nullableavailabilities array (default: [])@type string (default: "IdpCardAvailability")intake_date integer nullableapplication_deadline integer nullableannual_fee number nullablecurrency string nullableduration number nullableduration_unit string nullablecampus_city string nullablecampus_country_code 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.