# ESFA APAR UKPRN Portfolio Status Monitor (`plym-actor-factory/uk-esfa-apar-ukprn-status-monitor`) Actor

Watch UKPRNs and emit typed APAR APPEARED/DROPPED/STATUS\_CHANGED/DELIVER\_\* events from the official DfE/ESFA Apprenticeship Provider and Assessment Register CSV. Not Ofsted URN twin; not Ofqual AO twin; not full UKRLP scrape; not unpaid training-SaaS.

- **URL**: https://apify.com/plym-actor-factory/uk-esfa-apar-ukprn-status-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 apar ukprn 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

## ESFA APAR UKPRN Portfolio Status Event Monitor

Watch a book of **UKPRNs** and emit typed eligibility/status events when the official **DfE / ESFA Apprenticeship Provider and Assessment Register (APAR)** CSV shows a provider **appearing**, **leaving the published register**, flipping **Status** (e.g. “Not Currently Starting New Apprentices”), or flipping **CanDeliverApprenticeships / CanDeliverApprenticeshipUnits**.

**Not** Ofsted URN inspection twin (#26). **Not** Ofqual AO/qualification change twin. **Not** a full UKRLP provider-directory scrape (APAR is the funded apprenticeship eligibility slice with status/deliver flags). **Not** unpaid training-SaaS scrape.

### Coverage honesty (UKPRN exact match + APAR CSV only)

- **Source:** Official DfE/ESFA APAR download landing page\
  `https://download.apprenticeships.education.gov.uk/apar`\
  → rotating CSV ` /apar/downloadcsv?filename=apar-….csv`\
  (live-verified; fields include durable `Ukprn`, `Name`, `ApplicationType`, `Status`, `CanDeliverApprenticeships`, `CanDeliverApprenticeshipUnits`, `StartDate`, `ApplicationDeterminedDate`).
- **Keys:** **UKPRN exact match** after normalize (digits only; typically 8 digits). Provider name is **not** used as a primary match.
- **Cadence:** Follows DfE APAR publish / filename rotation (not intra-day streaming).
- **Scope:** APAR funded-apprenticeship eligibility slice only — do **not** claim full UKRLP directory coverage or Ofsted inspection grades.

### Events

| Event | When |
|-------|------|
| `APAR_APPEARED` | Watched UKPRN missing → present on APAR |
| `APAR_DROPPED` | Watched UKPRN present → missing from APAR |
| `APAR_STATUS_CHANGED` | `Status` cell changed while still present |
| `APAR_DELIVER_APPRENTICESHIPS_CHANGED` | `CanDeliverApprenticeships` flipped |
| `APAR_DELIVER_UNITS_CHANGED` | `CanDeliverApprenticeshipUnits` flipped |
| `RUN_STATUS` | Non-billable health row every successful run |

First observation of a UKPRN stores a **baseline only** (no product charge).

### Modes

- **`sourceMode=fixture`** (default): Store health / CI. With `emitFixtureDemoEvents=false` (default) emits **only** `RUN_STATUS` / `FIXTURE_HEALTH` → **0** product charges.
- **`sourceMode=live`**: Official APAR CSV via landing-page discovery (**no API key**). One CSV pull, then in-memory filter to the watchlist — does **not** bill national rows.

### Pricing (Model A)

- `apar-ukprn-status-event-delivered` @ **$0.02** / unique delivered event
- `apify-actor-start` @ **$0.00005**
- Quiet books ≈ $0 product charge

### Input

See `.actor/input_schema.json`. Primary field: `ukprns` (alias `providerNumbers`). Optional `signalGroups`: `directory`, `status`, `deliver`.

### Legal

**GREEN** — DfE APAR public download (OGL / public-sector open data practice). Cite DfE APAR + retrieval date. Default product fields = UKPRN + name + application type + status + deliver flags (org data; no consumer PII).

### A1b wedge

UKPRN watchlist × scheduled official APAR CSV snapshot diff → typed eligibility/status/deliver-flag events only for the book. Same-job Store niche empty; adjacent wrong register: Ofqual NEW change signals (`starshaped_bullsnake/ofqual-qualification-organisation-change-signals`, 1 MAU, 2026-09-15); Ofsted (#26) is URN inspection outcomes. See `opportunity/reports/phase3-a1b-next3-v15.md` (#3 PASS → build #43). Competitors cited from v15 only.

### Private

`isPublic` must remain **false** for this launch.

# Actor input Schema

## `ukprns` (type: `array`):

UK Provider Reference Numbers to monitor against the official DfE/ESFA APAR CSV. Exact match after normalize (digits only; typically 8 digits). Invalid entries are skipped with no charge. Not a nationwide provider dump — only UKPRNs on the book are evaluated.

## `providerNumbers` (type: `array`):

Optional alias for ukprns — same UKPRN keys, merged into the watchlist.

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

Which change groups to evaluate: directory (APPEARED/DROPPED), status (Status field), deliver (CanDeliverApprenticeships / CanDeliverApprenticeshipUnits). Default: all.

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

Wall-clock budget for the run (landing-page discover + CSV fetch + 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 provider 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 DfE/ESFA APAR CSV via /apar landing page (no API key).

## `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 APAR events or charge apar-ukprn-status-event-delivered. Production: leave false and use sourceMode=live.

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

Optional as\_of label for events / RUN\_STATUS. Defaults to date embedded in the rotating APAR CSV filename when present.

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

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

## `csvUrl` (type: `string`):

Optional direct CSV URL override (skips landing-page discovery). Default discovers via https://download.apprenticeships.education.gov.uk/apar → /apar/downloadcsv?filename=apar-….csv

## `landingUrl` (type: `string`):

Optional override for the APAR download landing page used to discover the rotating CSV filename.

## Actor input object example

```json
{
  "ukprns": [
    "10000501",
    "10007146",
    "10091927"
  ],
  "signalGroups": [
    "directory",
    "status",
    "deliver"
  ],
  "maxRunSeconds": 55,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false
}
```

# Actor output Schema

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

JSON summary: delivered, charged, runStatus, checkpoint, stats, APAR UKPRN 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/uk-esfa-apar-ukprn-status-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/uk-esfa-apar-ukprn-status-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/uk-esfa-apar-ukprn-status-monitor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,plym-actor-factory/uk-esfa-apar-ukprn-status-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/9Ij8qd0NDG6V0SqNO/builds/7zhMht9P5aDvAt6Ra/openapi.json