POST /api/studyaustralia/scholarships
Price: 5 credits
Get one Study Australia scholarship by its id: amount, duration, frequency, eligibility, application dates, who may apply, levels and fields of study and the offering providers with their campuses.
Read an Australian scholarship from an id returned by studyaustralia/scholarships/search or a scholarship page link.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)scholarship string required — Study Australia scholarship id or scholarship page URL (examples: "163a5ef1b81e1f7fc5db942b5168999b", "https://search.studyaustralia.gov.au/scholarship/x/163a5ef1b81e1f7fc5db942b5168999b")@type string (default: "StudyaustraliaScholarship")id string requiredscholarship_number string nullableurl string requiredalias string nullablename string requireddescription string nullablesummary string nullableeligibility string nullablewebsite_url string nullableamount_annual number nullableamount_max number nullableamount_info string nullableduration number nullableduration_unit_id string nullableduration_unit string nullablefrequency_id string nullablefrequency string nullablenumber_per_year integer nullableage_min integer nullableage_max integer nullableapplication_closes string nullableavailable_from string nullableavailable_until string nullableis_for_australian_students boolean nullableis_for_international_students boolean nullableis_tenable_overseas boolean nullableis_all_fields_of_study boolean nullablestudent_type_id string nullablestudent_type string nullablecitizenship object nullable@type string (default: "StudyaustraliaCode")id string nullablekey string nullablename string nullableeligible_countries string nullablelevels_of_study array (default: [])@type string (default: "StudyaustraliaCode")id string nullablekey string nullablename string nullablefields_of_study array (default: [])@type string (default: "StudyaustraliaFieldOfStudy")id string nullablekey string nullablename string nullabledescription string nullableproviders array (default: [])@type string (default: "StudyaustraliaScholarshipProvider")id string requiredprovider_number string nullableurl string requiredalias string nullablename string nullabledescription string nullabletype_id string nullabletype string nullabletype_key string nullablesimple_type_id string nullablesimple_type string nullablesimple_type_key string nullablecricos_code string nullablerto_code string nullablewebsite_url string nullableimage string nullablesites array (default: [])@type string (default: "StudyaustraliaScholarshipSite")id string nullablestate string nullablecountry object nullable (see schema StudyaustraliaCode)is_in_qld_scope boolean nullableis_in_vic_scope boolean nullablecreated_at 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 Study Australia scholarship has that 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.