Search Programs
scorecard_search_programsRead-only
Find programs by CIP code across institutions, ranked by median earnings within the fetched school page. Accepts school-side filters (state, ownership, max cost). Minimum earnings is applied locally; totals and pagination count schools before local program filtering. Use scorecard_lookup_cip to convert program names to CIP codes. Returns school names and IDs alongside program earnings, cumulative Stafford/Grad PLUS debt, and IPEDS awards for follow-up calls to scorecard_get_school or scorecard_get_programs.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Zero-indexed page number. | |
| state | No | Comma-separated two-letter state codes; case and whitespace normalized, blanks unset. | |
| cip_code | No | CIP 4-digit code to search for (e.g. "11.07" for Computer Science). Use scorecard_lookup_cip to find codes. | |
| max_debt | No | Maximum median cumulative Stafford/Grad PLUS debt across institutions at the same academic level, inclusive; excludes unavailable debt. | |
| per_page | No | Schools per page (max 100); program rows may exceed this count. | |
| ownership | No | Restrict to school type: 1=public, 2=private nonprofit, 3=for-profit. | |
| min_earnings | No | Minimum 1-year median earnings, inclusive. Filters this school page locally and excludes unavailable earnings; school totals are unchanged. | |
| program_name | No | Case-insensitive title substring matched within the fetched school page. Ignored when cip_code is provided; use cip_code for upstream program matching. | |
| max_net_price | No | Maximum average net price at the school. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | The per_page limit that was applied. | |
| page | No | Current page (zero-indexed). | |
| error | No | Present when the call failed. Absent on success. | |
| query | No | Normalized effective selectors and pagination defaults. | |
| shown | No | Schools returned on this page. | |
| total | No | Total schools matching upstream filters, before pagination and local program filtering. | |
| notice | No | Recovery hint when no programs match or earnings data is unavailable. | |
| per_page | No | Results per page used. | |
| programs | No | Program results — multiple programs per school if school matches multiple CIP codes. Sorted by earnings descending (suppressed last). | |
| truncated | No | True when school pagination metadata indicates a later page exists. | |
| totalCount | No | Total schools matching upstream filters, before pagination and local program filtering. | |
| total_programs | No | Total programs returned across all result schools. | |
| suppressed_count | No | Programs with suppressed earnings. |