# Chicago Public Passenger Vehicle Portfolio Status Monitor (`plym-actor-factory/us-il-chicago-ppv-record-id-portfolio-status-monitor`) Actor

Watch named Chicago BACP Public Passenger Vehicle record IDs; emit APPEARED/DROPPED/STATUS_CHANGED from official data.cityofchicago.org Socrata tfm3-3j95. Portfolio PPE only — not a citywide dump; not cryptic Chicago Business Licenses; not Public Chauffeurs person licences.

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

## Pricing

from $20.00 / 1,000 chicago ppv 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

## Chicago Public Passenger Vehicle Portfolio Status Monitor

Watch named **Chicago BACP Public Passenger Vehicle (PPV) record IDs** against the official `data.cityofchicago.org` Socrata dataset [`tfm3-3j95`](https://data.cityofchicago.org/Transportation/Public-Passenger-Vehicle-Licenses/tfm3-3j95).

**Who this is for:** commercial auto / fleet insurers, taxi affiliations, medallion managers, ambulance/livery operators, and lending/risk desks that need recurring alerts when a named Chicago PPV licence appears, drops, or changes status (ACTIVE / VIOLATION / INACTIVE / REVOKED / SURRENDER / FORECLOSURE / …) or company / location / vehicle attributes.

Billable events (PPE `chicago-ppv-status-event-delivered` @ $0.02):

- `APPEARED` / `DROPPED`
- `STATUS_CHANGED` (ACTIVE / VIOLATION / INACTIVE / RESERVED / SURRENDER / REVOKED / HOLD / FORECLOSURE)
- Attribute changes (company / location / vehicle) when `signalGroups` includes `attributes`

Non-billable: `RUN_STATUS` (`FIXTURE_HEALTH`, `MONITOR_IDLE`, `CATCHUP_COMPLETE`, `HEALTH_OK`). Quiet books stay free.

**Not** cryptic Chicago Business Licenses (`r5kz-chrr` AAI/AAC). **Not** Public Chauffeurs person licences (`97wa-y6ff`). **Not** a citywide dump billed as rows — watchlist `$where` only.

### Quick start

1. Replace the example `recordIds` with your watchlist (`{public_vehicle_number}{VehicleType}`, e.g. `1767Taxi`).
2. Set `sourceMode` = **live**.
3. Save as an Actor Task and schedule (e.g. daily).
4. **First run vs later runs:** run 1 baselines named record IDs (no change events, no product charge). Run 2+ emit diffs against that checkpoint — keep the same Task.

Default `sourceMode=fixture` is a **free health check** (one non-billable `RUN_STATUS` row), not product data.

### What you get per $0.02 event

One delivered unique change for a named Chicago PPV record (APPEARED / DROPPED / STATUS_CHANGED / attribute change). Never charged: `RUN_STATUS`, baselines, quiet `MONITOR_IDLE`, fixture SAMPLE rows.

### Example output (SAMPLE)

SAMPLE — illustrative field shape; not a real event:

```json
{
  "license_number": "SAMPLE01",
  "event_type": "STATUS_CHANGED",
  "previous_value": "ACTIVE",
  "new_value": "VIOLATION",
  "billable": false,
  "sample": true,
  "summary": "SAMPLE (fixture demo data with placeholder entities, not a real event)"
}
```

### Input

- `recordIds` — list of PPV record IDs (aliases: `licenseNumbers`, `licenses`, `credentials`)
- `sourceMode` — `fixture` (free health check) | `live` (official Chicago BACP)
- `signalGroups` — `directory`, `status`, `attributes`

### Source

- Official Socrata: `https://data.cityofchicago.org/resource/tfm3-3j95.json`
- Durable key: `record_id` (~16,328 unique = `public_vehicle_number` + `vehicle_type`)
- Status enum: ACTIVE / VIOLATION / INACTIVE / RESERVED / SURRENDER / REVOKED / HOLD / FORECLOSURE
- Cadence honesty: data.cityofchicago.org / BACP republish (not a real-time push)

### Pricing

| Event | USD |
|-------|-----|
| `chicago-ppv-status-event-delivered` | $0.02 |
| `apify-actor-start` | $0.00005 |

### Limitations

- Source lag follows BACP / data.cityofchicago.org republish cadence; not instant.
- `public_vehicle_number` alone is **not** unique across vehicle types — always use `record_id` (or number+type).
- Covers vehicle licences (Taxi, Livery, Ambulance, Medicar, Charter Sightseeing, Pedicab, etc.), not chauffeur person licences.

# Actor input Schema

## `recordIds` (type: `array`):

Chicago BACP Public Passenger Vehicle record_id values (field record_id on data.cityofchicago.org/tfm3-3j95) to monitor. Format = public_vehicle_number + vehicle_type (e.g. 1767Taxi, 7469Livery). Also accepts '1767 Taxi' or 'Taxi/1767'. These defaults are public-register examples to replace. Invalid entries skipped with no charge. Not a citywide dump — only IDs on the book are evaluated.

## `credentialNumbers` (type: `array`):

Alias of recordIds.

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

Alias of recordIds.

## `licenses` (type: `array`):

Alias of recordIds.

## `licenseNos` (type: `array`):

Alias of recordIds.

## `credentials` (type: `array`):

Alias of recordIds.

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

directory = APPEARED/DROPPED; status = STATUS_CHANGED; attributes = company / location / vehicle attribute changes.

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

Hard run budget in seconds.

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

Max billable change events to deliver this run.

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

Resume entity baselines and seen event UIDs from the actor key-value store.

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

fixture = free health check (default; one RUN_STATUS row). live = official data.cityofchicago.org / BACP Socrata (production).

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

When sourceMode=fixture, emit CATCHUP APPEARED/DROPPED/STATUS_CHANGED demo events (SAMPLE-flagged; never charged).

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

Optional as-of date hint (YYYY-MM-DD) for live runs.

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

Optional Apify platform max total charge USD for this run.

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

Override official Chicago PPV Socrata resource endpoint (default https://data.cityofchicago.org/resource/tfm3-3j95.json).

## Actor input object example

```json
{
  "recordIds": [
    "1767Taxi",
    "7469Livery",
    "1597Taxi",
    "7768Livery"
  ],
  "signalGroups": [
    "directory",
    "status"
  ],
  "maxRunSeconds": 180,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false,
  "socrataUrl": "https://data.cityofchicago.org/resource/tfm3-3j95.json"
}
```

# Actor output Schema

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

JSON summary: delivered, charged, runStatus, checkpoint, stats, NOLA PPV numstring 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-chicago-ppv-record-id-portfolio-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/us-il-chicago-ppv-record-id-portfolio-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/us-il-chicago-ppv-record-id-portfolio-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/us-il-chicago-ppv-record-id-portfolio-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/sqxX4porD6rbUSzkz/builds/6jB705dUfW5tTggP3/openapi.json