# College Scorecard Operating Status Portfolio Monitor (`plym-actor-factory/us-college-scorecard-operating-portfolio-monitor`) Actor

Watch IPEDS UNITIDs / OPEIDs and emit typed OPERATING\_OPEN / OPERATING\_CLOSED / OWNERSHIP\_CHANGED events from the official US ED College Scorecard API. Not Scorecard outcomes dump; not Ofsted/Ofqual twin; not Title IV PEPS claim; not unpaid ed-SaaS.

- **URL**: https://apify.com/plym-actor-factory/us-college-scorecard-operating-portfolio-monitor.md
- **Developed by:** [Daniel Witney](https://apify.com/plym-actor-factory) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $20.00 / 1,000 scorecard operating status event delivereds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## College Scorecard Institution Operating Status Portfolio Monitor

Watch a book of **IPEDS UNITIDs** (preferred) and/or **OPEIDs** (secondary) and emit typed operating / ownership events when the official **US Dept of Education College Scorecard** API shows an institution flipping **`school.operating`** (open ↔ closed) or changing **`school.ownership`**.

**Not** a Scorecard outcomes / earnings / student-debt dump. **Not** an Ofsted URN inspection twin. **Not** an Ofqual AO/qualification twin. **Not** a Title IV PEPS eligibility / cohort-default / financial-responsibility composite claim. **Not** unpaid ed-SaaS.

### Why this Actor (A1b — phase3-a1b-next3-v15.md)

Same-job shelf: **0** quiet UNITID/OPEID operating-status portfolio PPE products. Adjacent wrong jobs cited from v15 only:

| Actor | Why wrong job |
|-------|----------------|
| `nexgensignal/higher-education-institution-records` (1 MAU, NEW) | Flat IPEDS **register dump** |
| `retrainmap/college-scorecard-schools` (1, NEW) | Scorecard **outcomes dump** |
| `crawlerbros/college-scorecard-schools-scraper` (1) | Outcomes / school rows dump |
| `parseforge/ed-college-navigator-scraper` (1) | Navigator leads dump |

Material wedge: **UNITID/OPEID watchlist × scheduled official Scorecard snapshot diff → typed operating/ownership events only for the book**.

### Matching honesty

- Primary key: **UNITID** (`id`) exact match after normalize (digits; leading zeros stripped).
- Secondary key: **OPEID** — prefer `ope8_id` (8 digits); 6-digit `ope6` accepted and padded with trailing `00`.
- Name / accreditor / state / city / ownership label are **evidence fields**, not alternate match keys.
- First observation of each watch key = **baseline only** (no product charge).

### Events (PPE)

| Event | When |
|-------|------|
| `SCORECARD_OPERATING_OPEN` | `school.operating` becomes `1`, or appears on Scorecard as operating |
| `SCORECARD_OPERATING_CLOSED` | `school.operating` becomes `0`, or drops off Scorecard for the watch key |
| `SCORECARD_OWNERSHIP_CHANGED` | `school.ownership` code changes (1=public, 2=private nonprofit, 3=private for-profit) |

Plus one non-billable `RUN_STATUS` / `FIXTURE_HEALTH` health row per run (Store auto-test path).

### Source

- Official College Scorecard: `https://api.data.gov/ed/collegescorecard/v1/schools.json`
- Free **DEMO\_KEY** OK for smoke (rate-limited). Prefer env `DATA_GOV_API_KEY` (or input `dataGovApiKey`) for production books.
- Fields used: `id`, `ope6_id`, `ope8_id`, `school.name`, `school.operating`, `school.ownership`, `school.accreditor`, `school.state`, `school.city`.
- Cadence = Scorecard refresh. Live path uses **per-id lookup** (portfolio-safe — not national dump billing).

### Modes

| `sourceMode` | Behavior |
|--------------|----------|
| `fixture` (default) | Store auto-test: `RUN_STATUS` only unless `emitFixtureDemoEvents=true` |
| `live` | Official Scorecard API (`DEMO_KEY` or `DATA_GOV_API_KEY`) |

### Pricing (Model A — ADR 0010)

- `scorecard-operating-status-event-delivered` @ **$0.02** / unique delivered event ($20 / 1k)
- `apify-actor-start` @ **$0.00005**
- Quiet / baseline / fixture health → **0** product charges

### Legal

**GREEN** — ED College Scorecard / api.data.gov public API terms. Cite ED Scorecard + retrieval date. Institution/org data (UNITID/OPEID + name + operating + ownership + accreditor).

### Coverage limits (honest)

- Scorecard **`school.operating` / ownership** only — README does **not** claim Title IV PEPS eligibility, cohort-default, or financial-responsibility composite scores.
- Absence from Scorecard ≠ every higher-ed determination / PEPS status.
- Not outcomes dump, not Ofsted twin, not Ofqual twin, not unpaid ed-SaaS.

# Actor input Schema

## `unitids` (type: `array`):

IPEDS UNITID values (College Scorecard `id`). Exact match after normalize. Preferred primary keys. Invalid entries are skipped with no charge. Not a national Scorecard dump — only IDs on the book are evaluated.

## `unitIds` (type: `array`):

Alias for unitids.

## `opeids` (type: `array`):

OPEID values — prefer 8-digit ope8\_id; 6-digit ope6 accepted and padded with trailing 00. Secondary to UNITID.

## `opeIds` (type: `array`):

Alias for opeids.

## `ope8Ids` (type: `array`):

Alias for opeids (explicit ope8).

## `signalGroups` (type: `array`):

Which change groups to evaluate: operating (OPEN/CLOSED on school.operating), ownership (OWNERSHIP\_CHANGED on school.ownership). Default: all.

## `maxRunSeconds` (type: `integer`):

Wall-clock budget for the run (API lookups + watchlist diff).

## `maxEvents` (type: `integer`):

Stop after this many unique change events are delivered (does not include RUN\_STATUS).

## `resumeFromCheckpoint` (type: `boolean`):

If true, resume institution snapshots and seen event\_uids from the default Key-Value Store.

## `sourceMode` (type: `string`):

fixture = local/CI / Apify Store daily auto-test default (no network; emits RUN\_STATUS only unless emitFixtureDemoEvents=true). live = official College Scorecard API (DEMO\_KEY or DATA\_GOV\_API\_KEY). Not Scorecard outcomes dump; not Ofsted/Ofqual twin; not PEPS claim; not unpaid ed-SaaS.

## `emitFixtureDemoEvents` (type: `boolean`):

When sourceMode=fixture, if true push fabricated change events from local fixtures (unit/local demos only). Default false so Store daily auto-tests never emit fake Scorecard events or charge scorecard-operating-status-event-delivered. Production: leave false and use sourceMode=live.

## `asOfHint` (type: `string`):

Optional as\_of label for events / RUN\_STATUS (retrieval date).

## `maxTotalChargeUsd` (type: `number`):

Optional soft budget hint for delivered change events. Platform ACTOR\_MAX\_TOTAL\_CHARGE\_USD also applies when set.

## `scorecardApiUrl` (type: `string`):

Optional override for the official College Scorecard schools.json endpoint. Default: https://api.data.gov/ed/collegescorecard/v1/schools.json

## `dataGovApiKey` (type: `string`):

Optional. Prefer env DATA\_GOV\_API\_KEY when unset. DEMO\_KEY works for smoke but is rate-limited.

## Actor input object example

```json
{
  "unitids": [
    "166027",
    "100654"
  ],
  "signalGroups": [
    "operating",
    "ownership"
  ],
  "maxRunSeconds": 55,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false
}
```

# Actor output Schema

## `OUTPUT` (type: `string`):

JSON summary: delivered, charged, runStatus, checkpoint, stats, Scorecard operating coverage limits

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("plym-actor-factory/us-college-scorecard-operating-portfolio-monitor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("plym-actor-factory/us-college-scorecard-operating-portfolio-monitor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call plym-actor-factory/us-college-scorecard-operating-portfolio-monitor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,plym-actor-factory/us-college-scorecard-operating-portfolio-monitor"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/9t0ltTb3JYCrA7eOO/builds/2hIrjxtdxgzrVzTO5/openapi.json