/collegescorecard/schools/programs

POST /api/collegescorecard/schools/programs

Price: 20 credits

List every field of study an institution awards credentials in, with the CIP code and credential level, the number of awards, median graduate and parent PLUS loan debt, median earnings one, four and five years after completing, and how the programme's borrowers are repaying

How to use it

Field-of-study outcomes for one institution, keyed by the IPEDS UNITID. A field of study appears once per credential level, so the same CIP code can be present as a certificate, a bachelor's and a master's with entirely different debt and earnings — match on `cip_code` together with `credential`, never on `cip_code` alone. Earnings and debt come from federal aid records, so a programme whose students borrow little reports them as absent rather than as zero, and the Department suppresses any cell with too few students. `ipeds_awards_1_count` and `ipeds_awards_2_count` are the two pooled award years Scorecard reports and they are not a time series you can subtract. The institution-wide picture is collegescorecard/schools; this endpoint never aggregates to it.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• school string required — College Scorecard institution id, which is the IPEDS UNITID (examples: "104151", "166683", "228723"; minLength: 1)
• count integer required — Max number of fields of study to return (min: 1; max: 2000)

Response

• @type string (default: "CollegescorecardProgramOutcome")
• id string required
• school_id string nullable
• school_name string nullable
• school_ope6_id string nullable
• school_type string nullable
• is_main_campus boolean nullable
• cip_code string nullable
• field_of_study string nullable
• credential_level_code string nullable
• credential string nullable
• distance_education_code string nullable
• ipeds_awards_1_count integer nullable
• ipeds_awards_2_count integer nullable
• median_debt_graduate_plus number nullable
• median_monthly_payment_graduate_plus number nullable
• borrower_count_graduate_plus integer nullable
• median_debt_parent_plus number nullable
• median_monthly_payment_parent_plus number nullable
• borrower_count_parent_plus integer nullable
• earnings array (default: [])
  • @type string (default: "CollegescorecardProgramEarnings")
  • years_after_completion integer nullable
  • median_earnings number nullable
  • median_earnings_pell number nullable
  • median_earnings_no_pell number nullable
  • working_not_enrolled_count integer nullable
  • not_working_not_enrolled_count integer nullable
  • earning_above_high_school_graduate_count integer nullable
  • working_in_institution_state_count integer nullable
• repayment array (default: [])
  • @type string (default: "CollegescorecardProgramRepayment")
  • years_after_entering_repayment integer nullable
  • borrower_count integer nullable
  • fully_paid_count integer nullable
  • making_progress_count integer nullable
  • no_progress_count integer nullable
  • delinquent_count integer nullable
  • default_count integer nullable
  • deferment_count integer nullable
  • forbearance_count integer nullable
  • discharged_count integer nullable

Errors

• 422 — 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 College Scorecard institution with 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.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-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.