POST /api/cricos/institutions
Price: 20 credits
Get one institution from the CRICOS register by its CRICOS provider code: legal and trading name, type, capacity, website, postal address, executive and international student contacts, every location with address and coordinates, and every active course with level and duration
Look up one education provider registered to teach overseas students in Australia. Each course in `courses` is listed by name; cricos/courses/search with the course name returns its id.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)provider string required — CRICOS provider code or CRICOS institution page URL (examples: "00098G", "https://cricos.education.gov.au/Institution/InstitutionDetails.aspx?ProviderCode=01688K")@type string (default: "CricosInstitution")code string requiredprovider_id string nullablename string nullabletrading_name string nullableinstitution_type string nullablecapacity integer nullablenational_registration_at integer nullablewebsite string nullablepostal_address string nullableurl string requiredprincipal_executive_officer object nullable@type string (default: "CricosContact")name string nullabletitle string nullablephone string nullablefax string nullableemail string nullableinternational_student_contact object nullable@type string (default: "CricosContact")name string nullabletitle string nullablephone string nullablefax string nullableemail string nullablecourse_count integer nullablelocation_count integer nullablelocations array (default: [])@type string (default: "CricosInstitutionLocation")name string requiredstate string nullablecourse_count integer nullableaddress string nullablelocality string nullablepostcode string nullablelatitude number nullablelongitude number nullablephone string nullablefax string nullablecourses array (default: [])@type string (default: "CricosInstitutionCourse")name string requiredlevel string nullableduration_weeks 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 is registered under this provider code 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.