# Illinois IDFPR License Portfolio Status Monitor (`plym-actor-factory/us-il-idfpr-license-portfolio-monitor`) Actor

Watch Illinois IDFPR license\_number values and emit typed ACTIVE/status/expiry/discipline/reappeared events from official Illinois Open Data Socrata pzzh-kp68. Not a statewide dump billed as rows; not CA DCA/FL DBPR HTML twin; not unpaid credentialing SaaS.

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

## Pricing

from $20.00 / 1,000 idfpr license 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

## Illinois IDFPR License Number Portfolio Status Event Monitor

Watch a book of **Illinois IDFPR `license_number` values** and emit typed **ACTIVE / status / expiry / discipline / reappeared** events when the official **Illinois Open Data IDFPR Professional Licensing** Socrata snapshot (`pzzh-kp68`) changes for licences on that book.

**Not** a statewide 1.2M-row dump billed as rows. **Not** a CA DCA / FL DBPR HTML twin. **Not** unpaid credentialing SaaS scrape.

### Job (A1b wedge)

Illinois hospital credentialing / payer network / staffing / marketplace compliance desks track a **customer-owned licence book** and need Slack/JSON when a watched licence **leaves ACTIVE**, **expires / is not renewed**, **gains discipline flags**, or **re-appears** — without re-pulling the statewide extract by hand.

A1b competitors cited from **phase3-a1b-next3-v13.md only**: **0** quiet licence#-portfolio status-event PPE products. Dump/leads (different job): `haketa/illinois-idfpr-license-scraper` (**4 MAU** — “1.2M+ Records” flat extract); `crawlerbros/illinois-idfpr-license-scraper` (**1**); `scrapesage/illinois-license-leads-scraper` (**1**). Multi-state verify tools are **lookup**, not portfolio change.

### Source (official only)

| Path | URL | Notes |
|------|-----|-------|
| Portfolio live | `https://data.illinois.gov/resource/pzzh-kp68.json` | Official Illinois Open Data Socrata; live-verified 200; SoQL `license_number in(...)` for the book only |
| Dataset | Illinois Open Data — Professional Licensing (`pzzh-kp68`) | Attribution: IDFPR; ODBL |

No API key. Cite **IDFPR** + retrieval date. Default product fields = licence number + type + status + discipline flag + business/name + dates (licence/org data; minimise unnecessary personal fields).

### Matching honesty

- **Primary key:** `license_number` exact match after normalize (trim, collapse spaces, uppercase; reject empty / redacted `*` keys).
- **IL IDFPR only** — covers IDFPR-published Divisions of Professional Regulation / Real Estate / collection agencies on `pzzh-kp68`. Does **not** claim every Illinois licence regime.
- Cadence follows Socrata refresh (business-daily) — scheduled snapshot poll, not streaming.
- First observation of a licence = **baseline only** (no product charge).
- Quiet / unchanged books ≈ **$0** product charge.

### Events (PPE)

| Event | When |
|-------|------|
| `IDFPR_ACTIVE` | New / changed status is `ACTIVE` (incl. `ACTIVE …` variants) |
| `IDFPR_STATUS_CHANGED` | Other status flips (faithful `license_status` on subtype); also expiring-soon warning subtype |
| `IDFPR_EXPIRED_OR_DROPPED` | Status becomes expired/not-renewed/cancelled-like, or licence absent from Socrata for the watch key |
| `IDFPR_DISCIPLINE_FLAGGED` | `ever_disciplined` flips to Y |
| `IDFPR_REAPPEARED` | Was missing, now present with non-ACTIVE status |
| `RUN_STATUS` | Non-billable health row every successful run (`FIXTURE_HEALTH` / `MONITOR_IDLE` / …) |

### Modes

- **`sourceMode=fixture`** (default): Store auto-test / CI. With `emitFixtureDemoEvents=false` (default) emits **only** `RUN_STATUS` / `FIXTURE_HEALTH` → **0** product charges.
- **`sourceMode=live`**: Official Illinois Open Data IDFPR Socrata (**no API key**). Portfolio-safe — does **not** download the statewide extract.

### Pricing (Model A — ADR 0010)

- `idfpr-license-status-event-delivered` @ **$0.02** / unique delivered event ($20 / 1k)
- `apify-actor-start` @ **$0.00005**
- Quiet / baseline days ≈ **$0** product charge

### Legal

**GREEN** — Illinois open data / IDFPR Professional Licensing public Socrata; cite IDFPR + retrieval date. Default product = licence/org fields only.

### Input

See `.actor/input_schema.json`. Primary field: `licenseNumbers` (alias `licenceNumbers`). Optional `signalGroups`: `status`, `discipline`, `expiry`.

### Build order

Phase 3 **#35** (v13 A1b PASS #1 / GO #35). Pattern: UK FSA AppNo / US CMS PPEF / ACMA radiocomms licence portfolio monitors.

# Actor input Schema

## `licenseNumbers` (type: `array`):

Illinois IDFPR license\_number values to monitor against official Socrata pzzh-kp68. Exact match after normalize (trim/uppercase/collapse spaces; redacted \* keys rejected). Invalid entries skipped with no charge. Not a statewide dump — only numbers on the book are evaluated.

## `licenceNumbers` (type: `array`):

Optional alias for licenseNumbers — same license\_number keys, merged into the watchlist.

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

Which change groups to evaluate: status (ACTIVE/STATUS\_CHANGED/EXPIRED\_OR\_DROPPED/REAPPEARED), discipline (DISCIPLINE\_FLAGGED), expiry (expiring-soon warning via STATUS\_CHANGED subtype). Default: all.

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

Wall-clock budget for the run (Socrata 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 licence 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 Illinois Open Data IDFPR Socrata pzzh-kp68 (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 IDFPR events or charge idfpr-license-status-event-delivered. Production: leave false and use sourceMode=live. SAMPLE rows only: demo events use placeholder entities (never real companies/IDs), are flagged sample=true / isSample=true, and are NEVER charged.

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

Optional as\_of label for events / RUN\_STATUS. Defaults to Socrata Last-Modified date when present.

## `expiryWarningDays` (type: `integer`):

Days-ahead window for expiry-adjacent STATUS\_CHANGED subtype (default 90).

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

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

## `socrataUrl` (type: `string`):

Optional override for the official IDFPR Professional Licensing Socrata JSON endpoint. Default: https://data.illinois.gov/resource/pzzh-kp68.json

## Actor input object example

```json
{
  "licenseNumbers": [
    "225000006",
    "225000001",
    "225000008"
  ],
  "signalGroups": [
    "status",
    "discipline",
    "expiry"
  ],
  "maxRunSeconds": 55,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false,
  "expiryWarningDays": 90
}
```

# Actor output Schema

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

JSON summary: delivered, charged, runStatus, checkpoint, stats, IDFPR 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-il-idfpr-license-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-il-idfpr-license-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-il-idfpr-license-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-il-idfpr-license-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/jd3uTkWpuFdblbqtz/builds/gw6JkAqikFve5G90k/openapi.json