# /idp/courses/search

`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

## How to use it

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.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (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)

## Response

### 200 — Successful Response

- `@type` (string) (default: "IdpCourseCard")
- `id` (string, required)
- `name` (string, required)
- `url` (string, required)
- `subjects` (array) (default: [])
- `university` (object, nullable)
  - `@type` (string) (default: "IdpCardUniversity")
  - `id` (string, required)
  - `name` (string, nullable)
  - `alias` (string, nullable)
  - `image` (string, nullable)
- `study_level` (string, nullable)
- `ielts_score` (number, nullable)
- `the_rankings` (array) (default: [])
  - `@type` (string) (default: "IdpYearRank")
  - `year` (integer, required)
  - `rank` (integer, required)
- `campus_country` (string, nullable)
- `nearest_city` (string, nullable)
- `intake_date` (integer, nullable)
- `application_deadline` (integer, nullable)
- `annual_fee` (number, nullable)
- `currency` (string, nullable)
- `duration` (number, nullable)
- `duration_unit` (string, nullable)
- `has_scholarship` (boolean, nullable)
- `has_internship` (boolean, nullable)
- `is_oip` (boolean, nullable)
- `availabilities` (array) (default: [])
  - `@type` (string) (default: "IdpCardAvailability")
  - `intake_date` (integer, nullable)
  - `application_deadline` (integer, nullable)
  - `annual_fee` (number, nullable)
  - `currency` (string, nullable)
  - `duration` (number, nullable)
  - `duration_unit` (string, nullable)
  - `campus_city` (string, nullable)
  - `campus_country_code` (string, nullable)

## 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.

