POST /api/ipeds/completions-cip-6
Price: 20 credits
Degrees and certificates conferred by US colleges and universities, broken down by 6-digit detailed CIP programme, award level, first or second major, race and sex — the IPEDS Completions survey at the specific programme level, filterable by institution, state and every cross-tab axis
Programme completions at the detailed 6-digit CIP level (`cip_code` like 140701 Aerospace engineering). The 6-digit CIP vocabulary is external to the source, so most detailed codes come back with `cip_title` empty — the code itself is the programme id; use completions-cip-2 for titled broad families. Each row is one cell of a CIP x award-level x major-number x race x sex cross-tabulation, and the cross-tab carries its own totals inline: cip_code 99 is all programmes, race 99 and sex 99 are the 'Total' lines, so summing rows double-counts — filter to the single cell you want and read its `awards`. Narrow with `institution` (a UNITID, the same number College Scorecard returns as id) or `state`; an unfiltered award year is every US institution and runs to many pages. Coded axes come back as their official English labels; `awards` is the count conferred and 0 is a real, reported zero. Pass the IPEDS numeric codes to the `award_level`, `race`, `sex` and `major_number` filters.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)year integer — Award year the completions are read for (default: 2023; min: 1983; max: 2100)count integer required — Max number of completion rows to return (min: 1; max: 20000)institution string nullable — IPEDS UNITID, to read one institution's programmes (examples: "166683")state string nullable — Two-letter US state, DC or territory postal code to read a whole state (examples: "MA")award_level integer nullable — IPEDS award-level code, e.g. 7 Bachelor's, 9 Master's, 22 Doctor's (research), 4 Associate's (examples: 7)major_number integer nullable — 1 for a first (primary) major, 2 for a second major (examples: 1; min: 1; max: 2)race integer nullable — IPEDS race/ethnicity code, e.g. 1 White, 2 Black, 3 Hispanic, 99 Total (examples: 1)sex integer nullable — IPEDS sex code: 1 Male, 2 Female, 99 Total (examples: 1)cip_code_filter integer nullable — 6-digit detailed CIP code, e.g. 140701 Aerospace engineering, 110701 Computer science (examples: 140701)@type string (default: "IpedsCompletion")id string requiredinstitution_id string requiredyear integer nullablestate_fips string nullablecip_code string nullablecip_title string nullableaward_level string nullablemajor_number string nullablerace string nullablesex string nullableawards integer nullable422 — The IPEDS Completions survey covers 1983-2023 for 6-digit CIP 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 — The entity was not found, or a precondition failed 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.