POST /api/hotcoursesabroad/institutions
Price: 20 credits
Get one Hotcourses Abroad institution by its id or page URL: name, country, location, IDP institution id, website, rankings, average tuition fees, minimum IELTS scores, campuses with coordinates, subjects with course counts, profile sections, view and review counts and the student review summary.
One institution of the Hotcourses Abroad catalogue by id or page URL. `idp_institution_id` is the institution's id on idp.com. `is_advertiser` marks the richer advertiser profile layout; it does not predict the course list. hotcoursesabroad/institutions/courses lists its courses, which may be empty.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)institution string required — Hotcourses Abroad institution id or institution page URL (examples: "910", "https://www.hotcoursesabroad.com/study/uk/school-college-university/kingston-university-london/910/international.html", "https://www.hotcoursesabroad.com/study/student-reviews-ratings/university-of-bath/4093/rankings.html")@type string (default: "HotcoursesabroadInstitution")id string requiredname string nullableurl string nullableidp_institution_id string nullablecountry string nullablecountry_id string nullablelocation string nullableimage string nullablewebsite_url string nullableis_advertiser boolean nullableview_count integer nullablereview_count integer nullablerating integer nullableoverview string nullablerankings array (default: [])@type string (default: "HotcoursesabroadRanking")name string nullableyear integer nullablerank integer nullableinternational_nationality_count integer nullableaverage_tuition_fees array (default: [])@type string (default: "HotcoursesabroadAverageFee")study_level string nullableamount number nullablecurrency string nullabletext string nullableielts_minimums array (default: [])@type string (default: "HotcoursesabroadIeltsMinimum")study_level string nullablescore number nullablecampuses array (default: [])@type string (default: "HotcoursesabroadCampus")name string nullableaddress string nullablelatitude number nullablelongitude number nullablesubjects array (default: [])@type string (default: "HotcoursesabroadSubject")name string nullablecourse_count integer nullableurl string nullablesections array (default: [])@type string (default: "HotcoursesabroadSection")title string nullabletext string nullablereview_summary object nullable@type string (default: "HotcoursesabroadReviewSummary")overall_rating integer nullableadmission_rating integer nullablefunding_rating integer nullablestudy_rating integer nullablelife_rating integer nullablejob_prospects_rating integer nullablerecommend_percent number nullableview_count integer 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 — No institution matches this id or URL 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.