Find Institution
find_institution
Which institution is this? A name or an IPEDS UNITID answers with the institution's identity, sector, identifiers with their sources, how many programs, checklists, and learning units its published catalog holds here, and what else is stored about it: transfer agreements and pathways, prior learning policies and rules, the exam programs it grants credit for, on-campus housing, in-state tuition, veterans services and transfer credit policies. A name is read whole, never as a fragment: case, punctuation, a leading "The", "&" for "and", "St." for "Saint" and "X at Y" for "X-Y" are set aside, and a name equal to one school's, or to an IPEDS alias reviewed to name that school, is that school. Several fits, or a read only by initials, by an alias that does not name one school, or by words of a name, are candidates and none is chosen. Every answer says how it matched (matched_by) and whether it is one school (resolved). A state lists that state's institutions by name; a school type, or a filter on what is stored, lists across the country without a state, with the sectors of the schools listed and their counts; with none of these, the answer is the states that hold institutions, each with its count. A web address answers the institution that publishes it, so a school named by its own site is identified without an IPEDS number in hand. operational_status, open or closed, keeps the schools that are open or the schools that are not, and every institution row carries the operational_status the publish holds for it: one is held only for a school that is not open, such as closed or merged, and null stands for a school that holds none. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list.
Schema valid · SHA-256 39b0245db58f…
View input schema
{
"type": "object",
"properties": {
"city": {
"description": "Optional city, one of a state answer's cities, e.g. Denison",
"examples": [
"Denison"
],
"type": "string"
},
"domain": {
"description": "Optional: the institution's own web address, matched against the addresses it publishes, e.g. uindy.edu",
"examples": [
"uindy.edu"
],
"type": "string"
},
"exam_credit": {
"description": "Optional: only schools with a published rule granting credit for this exam program",
"enum": [
"AP",
"IB",
"CLEP",
"DSST"
],
"type": "string"
},
"limit": {
"description": "Optional page size (default 20, at most 100)",
"type": "integer"
},
"locale": {
"description": "Optional, where the publish holds the College Scorecard's characteristics: only schools in this setting (NCES locale)",
"enum": [
"city",
"suburb",
"town",
"rural"
],
"type": "string"
},
"offset": {
"description": "Optional: the next_offset from a previous answer",
"type": "integer"
},
"on_campus_housing": {
"description": "Optional: only schools that publish an on-campus room and board cost (College Scorecard)",
"type": "boolean"
},
"online_only": {
"description": "Optional, where the publish holds the College Scorecard's characteristics: only schools whose programs are all offered online",
"type": "boolean"
},
"operational_status": {
"description": "Optional: open or closed, by the school's operational status as the publish holds it. open keeps the schools that hold no status; closed keeps the schools that hold one, such as closed or merged. Each institution row, and each card's school, carries the operational_status held, null where none is",
"enum": [
"open",
"closed"
],
"type": "string"
},
"query": {
"description": "A school's name, its web address, or its IPEDS UNITID, e.g. University of Tennessee at Chattanooga, utc.edu or 221740; words of a name give candidates",
"examples": [
"Grayson",
"225070"
],
"type": "string"
},
"residential": {
"description": "Optional, where the publish holds the College Scorecard's characteristics: only primarily or highly residential four-year schools (Carnegie size and setting)",
"type": "boolean"
},
"sector": {
"description": "Optional school type as IPEDS labels it, e.g. public 2-year; without a state, that type's institutions across the country, those with a catalog held first",
"examples": [
"public 2-year"
],
"type": "string"
},
"state": {
"description": "Optional two-letter state, e.g. TX: that state's institutions, those with a catalog held first; the answer lists the state's cities",
"examples": [
"TX"
],
"type": "string"
},
"tuition_in_max": {
"description": "Optional: only schools whose in-state tuition and fees (College Scorecard) is at or under this many dollars a year",
"type": "number"
},
"with_agreements": {
"description": "Optional: only schools with at least one transfer agreement held",
"type": "boolean"
},
"with_pathways": {
"description": "Optional: only schools taking part in at least one pathway held",
"type": "boolean"
},
"with_prior_learning": {
"description": "Optional: only schools with a published prior learning policy or a published rule for credit for prior learning they receive",
"type": "boolean"
},
"with_transfer_policy": {
"description": "Optional: only schools with a published transfer credit policy",
"type": "boolean"
},
"with_veteran_services": {
"description": "Optional: only schools with veterans and military services held",
"type": "boolean"
}
}
}