POST /api/collegenavigator/institutions
Price: 5 credits
Get one US postsecondary institution from NCES College Navigator by its IPEDS UNITID: address, contacts, type, awards offered, enrolment and faculty, mission statement, services, tuition and expenses, financial aid, net price by income, admissions and test scores, retention, graduation and outcome rates, every programme with its CIP code and its latest published completions per award level, veterans' benefits, varsity teams, institutional and programmatic accreditation, campus crime counts, cohort default rates and the 90/10 revenue requirement result
Pass a UNITID from collegenavigator/institutions/search or ipeds. Programmes carry completions per award level, with 0 for a level offered but not awarded that year. Tables that differ by institution type (expenses, aid, net price, admissions, retention, outcomes) come as statistics rows of section, table, label, column and value.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)institution string required — IPEDS UNITID of the institution or branch campus, or its College Navigator page URL (examples: "166027", "12265801", "https://nces.ed.gov/collegenavigator/?id=166027"; minLength: 1)@type string (default: "CollegeNavigatorInstitution")id string requiredope_id string nullablename string requiredurl string requiredaddress string nullablestreet string nullablecity string nullablestate string nullablestate_code string nullablezip_code string nullablephone string nullablewebsite_url string nullablelevel string nullableaward_focus string nullablecontrol string nullableis_distance_education_only boolean (default: false)has_failed_90_10_requirement boolean (default: false)failed_90_10_fiscal_year integer nullableawards_offered array (default: [])campus_setting string nullablehas_campus_housing boolean nullablestudent_count integer nullableundergraduate_student_count integer nullablestudent_faculty_ratio number nullablerelated_institutions array (default: [])@type string (default: "CollegeNavigatorRelatedInstitution")id string requiredname string nullablerelation string nullablelinks array (default: [])@type string (default: "CollegeNavigatorLink")name string requiredurl string requiredmission_statement string nullablemission_statement_url string nullablespecial_learning_opportunities array (default: [])student_services array (default: [])disability_office_registered_share string nullabledisability_office_registered_year integer nullabledual_enrollment_student_count integer nullabledual_enrollment_academic_year string nullablecarnegie_classification string nullablereligious_affiliation string nullablefederal_aid string nullablecredit_programs_offered array (default: [])noncredit_education_offered array (default: [])credit_accepted array (default: [])additional_information array (default: [])@type string (default: "CollegeNavigatorFactList")name string requiredvalues array (default: [])has_open_admission boolean (default: false)veteran_services array (default: [])completions_academic_year string nullableprograms array (default: [])@type string (default: "CollegeNavigatorProgram")cip_code string nullabletitle string requiredcategory_code string nullableawards array (default: [])@type string (default: "CollegeNavigatorAward")award_level string requiredcompletion_count integer nullableis_distance_education boolean (default: false)program_categories array (default: [])@type string (default: "CollegeNavigatorProgramCategory")code string nullabletitle string nullableawards array (default: [])@type string (default: "CollegeNavigatorAward")award_level string requiredcompletion_count integer nullableis_distance_education boolean (default: false)program_totals array (default: [])@type string (default: "CollegeNavigatorAward")award_level string requiredcompletion_count integer nullableis_distance_education boolean (default: false)sports_sanction_body string nullablesports_teams array (default: [])@type string (default: "CollegeNavigatorTeam")sport string requiredmen_participant_count integer nullablewomen_participant_count integer nullableaccreditations array (default: [])@type string (default: "CollegeNavigatorAccreditation")scope string nullableaccreditor string nullableprogram string nullablestatus string nullableaccredited_since integer nullableaccredited_until integer nullableis_since_estimated boolean (default: false)next_review_at integer nullablecrime_counts array (default: [])@type string (default: "CollegeNavigatorCrimeCount")location string nullablecategory string nullableoffense string requiredyear integer requiredincident_count integer nullablecohort_default_rates array (default: [])@type string (default: "CollegeNavigatorDefaultRate")fiscal_year integer requireddefault_rate number nullabledefault_count integer nullablerepayment_count integer nullablestatistics array (default: [])@type string (default: "CollegeNavigatorStatistic")section string requiredtable string nullabletable_header string nullabletable_note string nullabledata_year string nullablegroup string nullablelabel string nullablecolumn string nullablevalue number nullableunit string nullable (one of: "usd", "percent", "number")text string nullablenotes array (default: [])@type string (default: "CollegeNavigatorNote")section string requiredtext string required422 — 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 with this UNITID is in College Navigator 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.