# NYC DCWP License Nbr Portfolio Status Monitor (`plym-actor-factory/us-nyc-dcwp-license-nbr-portfolio-status-monitor`) Actor

Watch NYC DCWP/DCA license\_nbr values for Active/Suspended/Revoked/Expired status and attribute changes from official NYC Open Data Socrata. PPE on unique portfolio events. Not a NYSLA liquor twin; not a lead-gen scraper; not a citywide dump billed as rows.

- **URL**: https://apify.com/plym-actor-factory/us-nyc-dcwp-license-nbr-portfolio-status-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 dcwp 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

## NYC DCWP License Nbr Portfolio Status Monitor

Watch a **book of NYC DCWP/DCA `license_nbr` values** and receive **typed status / membership events** when the official **NYC Open Data — Issued Licenses** Socrata dataset (`w7w3-xahh`) shows a license **appearing**, **dropping**, or changing **License Status** (Active / Expired / Ready for Renewal / Surrendered / Voided / Revoked / Failed to Renew / Suspended / Out of Business / Close) or key attributes.

**Not** a NYSLA liquor twin. **Not** a lead-gen / new-openings scraper. **Not** a citywide DCWP dump billed as rows.

### Source

- Official NYC Open Data DCWP Issued Licenses\
  `https://data.cityofnewyork.us/resource/w7w3-xahh.json`\
  Dataset page: https://data.cityofnewyork.us/dataset/Issued-Licenses/w7w3-xahh
- **Key:** `license_nbr` (durable)
- **Cadence:** Honest NYC Open Data / DCWP Socrata republish (rowsUpdatedAt / Last-Modified).
- **Drop meaning:** Removal from the published currently-available Issued Licenses dataset — not a full revocation mailer.

### Events

| Event | When |
|-------|------|
| APPEARED | license\_nbr newly present on the book |
| DROPPED | license\_nbr absent from current snapshot |
| STATUS\_CHANGED | `license_status` changed |
| Attribute events | business\_category / business\_name / business\_unique\_id / expiration |

Quiet books emit free `MONITOR_IDLE` / `RUN_STATUS` (not billed).

### Modes

- **`sourceMode=fixture`**: local/CI / Store daily auto-test (no network). Emits RUN\_STATUS only unless `emitFixtureDemoEvents=true`.
- **`sourceMode=live`**: Official Socrata JSON (**no API key**). Watchlist SoQL `license_nbr in(...)` only — does **not** bill citywide rows.

### Pricing (PPE)

- `dcwp-license-status-event-delivered` @ **$0.02** / unique delivered event
- Actor start @ **$0.00005**

### Input

See `.actor/input_schema.json`. Primary field: `licenseIds` (aliases `dcwpLicenseNbrs`, `licenses`). Optional `signalGroups`: `directory`, `status`, `attributes`.

### Compliance

**GREEN** — NYC Open Data / DCWP public licence register. Cite DCWP + retrieval date. Default product fields = license\_nbr + license\_status + business\_category + business\_name + business\_unique\_id + expiration.

### Why this wedge

license\_nbr watchlist × scheduled official DCWP Socrata snapshot diff → typed appear/drop/status events only for the book. Existing Store shelf is NYC business-licence **scrapers / registry dumps / lead feeds** (wrong buyer job). Quiet books emit free `MONITOR_IDLE`.

# Actor input Schema

## `licenseIds` (type: `array`):

NYC DCWP/DCA license\_nbr values to monitor against official Socrata w7w3-xahh. Exact match after normalize (trim; uppercase -DCA/-DCWP suffix). Invalid entries skipped with no charge. Not a citywide dump — only IDs on the book are evaluated.

## `dcwpLicenseNbrs` (type: `array`):

Optional alias for licenseIds — merged into the same watchlist.

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

Optional alias for licenseIds.

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

Which change groups to evaluate: directory (APPEARED/DROPPED), status (STATUS\_CHANGED on primary\_status), attributes (license\_type / trade\_name / owner / expiration / master\_file\_id). Default: directory + status.

## `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 NYC Open Data DCWP Issued Licenses Socrata w7w3-xahh (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 DCWP events or charge dcwp-license-status-event-delivered. Production: leave false and use sourceMode=live.

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

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

## `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 of official endpoint. Default: https://data.cityofnewyork.us/resource/w7w3-xahh.json

## Actor input object example

```json
{
  "licenseIds": [
    "0016371-DCA",
    "0225766-DCA",
    "0227765-DCA",
    "2127632-DCWP"
  ],
  "signalGroups": [
    "directory",
    "status"
  ],
  "maxRunSeconds": 180,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false
}
```

# Actor output Schema

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

JSON summary: delivered, charged, runStatus, checkpoint, stats, DCWP license\_nbr 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-nyc-dcwp-license-nbr-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-nyc-dcwp-license-nbr-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-nyc-dcwp-license-nbr-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-nyc-dcwp-license-nbr-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/A7gptAEOqWo7CwbLs/builds/3FNYhlaLTalrXpHt9/openapi.json