POST /api/idp/universities
Price: 10 credits
Get one university or college listed by IDP by its id or page URL: profile, type, website, logo, course count, rankings, international student count, campuses with addresses and coordinates, profile sections, photos and videos, and featured scholarships
Pass `alias` in `universities` to idp/courses/search for the courses this university offers; a university not in the course search (every UAE university and a few others) answers 422 there, and its courses are reached by course id through idp/courses.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)university string required — IDP university id or university page URL (examples: "IID-UK-00691", "https://www.idp.com/universities-and-colleges/university-of-bath/IID-UK-00691/")@type string (default: "IdpUniversity")id string requiredname string requiredalias string nullableurl string requireduniversity_type string nullablecountry string nullablecountry_code string nullablewebsite_url string nullableimage string nullablecover string nullabledescription string nullablecourse_count integer nullableinternational_student_count integer nullableapplication_success_rate number nullablethe_ranking string nullablecug_ranking integer nullablememberships string nullableis_ielts_accepted boolean nullablehas_on_campus_accommodation boolean nullableis_advertiser boolean nullableis_oip boolean nullableoip_enabled_countries array (default: [])oip_disabled_countries array (default: [])oip_disabled_undergraduate_countries array (default: [])oip_disabled_postgraduate_countries array (default: [])languages array (default: [])campuses array (default: [])@type string (default: "IdpCampus")id string nullablename string nullablecampus_type string nullablestreet string nullablecity string nullablestate string nullableregion string nullablepostal_code string nullablenearest_city string nullablecountry string nullablecountry_code string nullablelatitude number nullablelongitude number nullableinfo_url string nullablesections array (default: [])@type string (default: "IdpUniversitySection")category string nullabletitle string nullabletext string nullableposition integer nullablemedia_id string nullablemedia_type string nullablemedia_url string nullablemedia array (default: [])@type string (default: "IdpUniversityMedia")id string nullablemedia_type string nullableurl string nullablethumbnail string nullableis_hero boolean nullableis_gallery boolean nullableposition integer nullablescholarships array (default: [])@type string (default: "IdpScholarship")id string requiredname string nullableurl string nullablefunding_type string nullableaward_details string nullableaward_value string nullableaward_currency string nullableaward_value_aud number nullablestudy_level string nullablecountry_of_residence string nullableeligible_intakes string nullableapplication_deadline integer nullablecategories array (default: [])subjects array (default: [])422 — 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 university exists under this id 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.