Find My School
find_my_schoolWhere can I study this? A match-up, not a dump: for a major and a level, the schools that award it, ranked by how many of the person's own criteria each one meets, with met, not met and not testable kept as three different results — a school that does not publish a fact is not testable on it, never failed. Each criterion names the source that decided it, each school carries its own program, award, credits required, cost, earnings, debt and whether it can be done online, and a filter only ever excludes on a fact we hold. The answer states its ranking rule and never recommends a school. TODAY the candidate set is the schools CourseShelf has captured a program for, not yet every school IPEDS lists, and every answer opens by saying so.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | Optional city | |
| near | No | Optional: a place and a distance, e.g. Casper WY within 50 miles | |
| award | No | Optional award title or credential class | |
| level | Yes | The credential level, e.g. certificate, associate or bachelor's | |
| limit | No | Optional page size (default 10, at most 25) | |
| major | Yes | The major: a major_minor_id (e.g. CIP:51.3801) or a CIP code | |
| state | No | Optional two-letter state. With no state, city or place the answer is national and says so | |
| offset | No | Optional: the offset of the next page | |
| sector | No | Optional school type as IPEDS labels it, e.g. public 2-year | |
| cost_max | No | Optional: the most the person will pay. A school that publishes no cost is not removed by it — it is ranked below and marked not testable on cost | |
| delivery | No | Optional: in person, hybrid or online | |
| also_offers | No | Optional other subjects or majors the school should also offer | |
| with_checklist | No | Optional: only schools whose requirements CourseShelf holds | |
| exclude_untestable | No | Optional strict exclusion, off by default: remove schools that do not publish one of the criteria. The answer then says how many were removed and by which criterion |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | Said when the answer is national because no place was given | |
| schools | No | One row per school: its program with the route that joined it to the major, cost, earnings and debt, its programs that could not be joined, and its standing — every criterion with its verdict and source | |
| contract | Yes | ||
| not_held | No | ||
| statement | Yes | What the candidate set is, as the first thing the person reads | |
| understood | No | ||
| ranking_rule | No | ||
| candidate_set | No | Where the schools came from and why it is not yet IPEDS's list | |
| measure_not_met | No | The measure this build does not yet meet, named in the answer | |
| strict_exclusion | No | Present only when exclude_untestable was asked for: how many schools were removed, by which criterion |