# TTB Alcohol Permit Portfolio Status Monitor (`plym-actor-factory/us-ttb-alcohol-permit-status-monitor`) Actor

Watch TTB Permit\_Numbers and emit typed APPEARED/DROPPED/NEW\_FLAG/INDUSTRY\_CHANGED events from the official TTB FOIA List of Permittees JSON. Not state ABC retail twin; not COLA twin; not nationwide dump billed as rows; not unpaid beverage SaaS.

- **URL**: https://apify.com/plym-actor-factory/us-ttb-alcohol-permit-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 ttb permit 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

## TTB Federal Alcohol Permit Number Portfolio Status Event Monitor

Watch a book of **TTB Permit\_Numbers** and emit typed FOIA-list membership events when the official **Alcohol and Tobacco Tax and Trade Bureau FOIA List of Permittees** JSON shows a permit **appearing**, **dropping off the published list**, flipping **New\_Permit\_Flag**, or changing **Industry\_Type**.

**Not** a state ABC / retail liquor-license twin (`registryfeeds/liquor-license-monitor` and peers). **Not** a TTB COLA / label twin. **Not** a nationwide permittee dump billed as rows. **Not** unpaid beverage-SaaS scrape.

### Coverage honesty (Permit\_Number exact match + weekly FOIA cadence)

- **Source:** Official TTB FOIA List of Permittees consolidated JSON\
  `https://www.ttb.gov/system/files/2025-04/FRL_All_Permits.json`\
  (live-verified HTTP 200; `FOIA_All_Permittees.json` returns 404). Page: https://www.ttb.gov/public-information/foia/list-of-permittees. Weekly per-type CSVs also published on the same page.
- **Keys:** **Permit\_Number exact match** after normalize (trim / uppercase / collapse separators). Owner+state is **not** used as the primary match.
- **Cadence:** **Weekly** TTB FOIA refresh (not intra-day).
- **Coverage:** Federal FAA Act basic permits (importer / wholesaler / DSP / wine). IRC §6103 brewery / tobacco lists are **excluded by TTB** and are out of scope.
- **Drop meaning:** Removal from the published currently-available FOIA permittee files — **not** a full revocation docket mailer.

### Events

| Event | When |
|-------|------|
| `TTB_PERMIT_APPEARED` | Watched Permit\_Number missing → present on FOIA list |
| `TTB_PERMIT_DROPPED` | Watched Permit\_Number present → missing from FOIA list |
| `TTB_PERMIT_NEW_FLAG` | `New_Permit_Flag` changed while still present |
| `TTB_INDUSTRY_CHANGED` | `Industry_Type` changed while still present |
| `RUN_STATUS` | Non-billable health row every successful run |

First observation of a Permit\_Number 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 TTB FOIA JSON (**no API key**). One JSON pull, then in-memory filter to the watchlist — does **not** bill national rows.

### Pricing (Model A)

- `ttb-permit-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: `permitNumbers` (alias `permits`). Optional `signalGroups`: `presence`, `new_flag`, `industry`.

### Legal

**GREEN** — TTB FOIA frequently-requested public listings. Cite TTB + retrieval date. Default product fields = Permit\_Number + owner/operating names + industry type + premises city/state (org/facility data; IRC §6103 redactions already applied by TTB — do not attempt to recover withheld brewery/tobacco lists).

### A1b wedge

Permit\_Number watchlist × scheduled official TTB FOIA CSV/JSON snapshot diff → typed appear/drop/new-flag events only for the book. Existing Store shelf is lookup/DSP dump + COLA + state liquor change (wrong jobs). See `opportunity/reports/phase3-a1b-next3-v15.md` (#1 PASS / GO #41). Competitors cited from v15 only: `haketa/ttb-alcohol-permittee-scraper` (0 MAU — lookup/export); `automation-lab/ttb-distilled-spirits-plant-permittees` (1 — DSP roster dump); COLA scrapers `crawlerbros/ttb-cola-registry-scraper` / `scrapersdelight/ttb-cola-scraper`; state retail `registryfeeds/liquor-license-monitor`.

### Private

`isPublic` must remain **false** for this launch (PRIVATE ONLY).

# Actor input Schema

## `permitNumbers` (type: `array`):

TTB Permit\_Numbers to monitor against the official FOIA List of Permittees JSON (e.g. AK-I-15000). Exact match after normalize. Invalid entries skipped with no charge. Not a nationwide dump — only Permit\_Numbers on the book are evaluated.

## `permits` (type: `array`):

Optional alias for permitNumbers — same Permit\_Number keys, merged into the watchlist.

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

Which change groups to evaluate: presence (APPEARED/DROPPED), new\_flag, industry. Default: all.

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

Wall-clock budget for the run (JSON 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 permit 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 TTB FOIA All Permittees JSON (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 TTB events or charge ttb-permit-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 Last-Modified date from the FOIA JSON when present.

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

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

## `jsonUrl` (type: `string`):

Optional override for the official TTB FOIA All Permittees JSON. Default: https://www.ttb.gov/system/files/2025-04/FRL\_All\_Permits.json (live-verified; FOIA\_All\_Permittees.json returns 404).

## Actor input object example

```json
{
  "permitNumbers": [
    "AK-I-15000",
    "AK-P-15000",
    "AZ-I-21233"
  ],
  "signalGroups": [
    "presence",
    "new_flag",
    "industry"
  ],
  "maxRunSeconds": 120,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false
}
```

# Actor output Schema

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

JSON summary: delivered, charged, runStatus, checkpoint, stats, TTB Permit\_Number 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-ttb-alcohol-permit-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-ttb-alcohol-permit-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-ttb-alcohol-permit-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-ttb-alcohol-permit-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/yc9FGRmwOCyyvYuhG/builds/pmpZMBXv7kehodZ7o/openapi.json