# Queensland EA Permit Reference Portfolio Status Monitor (`plym-actor-factory/au-qld-ea-permit-reference-portfolio-status-monitor`) Actor

Watch Queensland Environmental Authority Permit References; emit APPEARED/DROPPED/STATUS\_CHANGED and attribute events from the official DESI ea-register.xlsx. Not an ASIC Credit twin; not a full EA dump billed as rows.

- **URL**: https://apify.com/plym-actor-factory/au-qld-ea-permit-reference-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 qld ea 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

## Queensland EA Permit Reference Portfolio Status Monitor

Watch named **Queensland Environmental Authority Permit References** against the official DESI `ea-register.xlsx` and emit typed portfolio events:

- `APPEARED` / `DROPPED` (directory membership)
- `STATUS_CHANGED` (Granted / Surrendered / Cancelled / Suspended / Granted - Not Effective / Expired / Disclaimed)
- Attribute events: holder, permit type, condition type, industry, activities, effective date

### Pricing (PPE)

| Event | USD |
|-------|----:|
| `qld-ea-status-event-delivered` | **0.02** |
| `apify-actor-start` | **0.00005** |

Quiet books emit non-billable `RUN_STATUS` (`MONITOR_IDLE` / `FIXTURE_HEALTH`) only.

### Input

- `permitReferences` — list of Permit References (aliases: `eaPermitReferences`, `qldEaNumbers`)
- `sourceMode` — `fixture` (default) or `live`
- `signalGroups` — `directory`, `status`, `attributes`

### Source

Official open data workbook published via [data.qld.gov.au — Environmental authorities register](https://www.data.qld.gov.au/dataset/environmental-authorities):

`https://storagesolutiondocsprod.blob.core.windows.net/register-documents-ea/ea-register.xlsx`

No API key. Cadence = honest DESI blob republish (Last-Modified).

### Not this Actor

- Not an ASIC Credit Licence twin (#67)
- Not a full QLD EA national dump billed per row
- Not EPC SEPA / FINMA / OCC / cannabis ID-less aggregates

### Coverage honesty

1. Official DESI EA register xlsx only — watchlist filter; not a dump bill.
2. `DROPPED` = absent from current xlsx snapshot (≠ Status=Surrendered/Cancelled/Expired which remain listed).
3. Honest DESI republish cadence (Last-Modified on ea-register.xlsx).

# Actor input Schema

## `permitReferences` (type: `array`):

Queensland Environmental Authority Permit References to watch (e.g. P-EA-100775384, EPSX00180713).

## `eaPermitReferences` (type: `array`):

Optional alias for permitReferences — same durable QLD EA Permit Reference keys, merged into the watchlist.

## `qldEaNumbers` (type: `array`):

Optional alias for permitReferences.

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

Which change groups to evaluate: directory (APPEARED/DROPPED), status (STATUS\_CHANGED), attributes (HOLDER/PERMIT\_TYPE/CONDITION\_TYPE/INDUSTRY/ACTIVITIES/EFFECTIVE\_DATE). Default: directory+status.

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

Wall-clock budget (xlsx download + parse + 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 Reference snapshots and seen event\_uids from the default Key-Value Store.

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

fixture = Store/CI health default (no network; RUN\_STATUS only unless emitFixtureDemoEvents=true). live = official QLD DESI Environmental Authorities register xlsx (no API key).

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

When sourceMode=fixture, if true emit fabricated change events from local fixtures for CI. Default false so Store health checks stay non-billing.

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

Optional PPE spend cap hint for the run (platform-enforced when configured).

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

Optional override for register as-of date when Last-Modified is unavailable.

## `qldEaXlsxUrl` (type: `string`):

Optional override for the official DESI ea-register.xlsx URL.

## Actor input object example

```json
{
  "permitReferences": [
    "P-EA-100775384",
    "EPSX00180713",
    "EPPR00829313",
    "EA0001913"
  ],
  "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, QLD EA Permit Reference 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 = {
    "permitReferences": [
        "P-EA-100775384",
        "EPSX00180713",
        "EPPR00829313",
        "EA0001913"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("plym-actor-factory/au-qld-ea-permit-reference-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 = { "permitReferences": [
        "P-EA-100775384",
        "EPSX00180713",
        "EPPR00829313",
        "EA0001913",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("plym-actor-factory/au-qld-ea-permit-reference-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 '{
  "permitReferences": [
    "P-EA-100775384",
    "EPSX00180713",
    "EPPR00829313",
    "EA0001913"
  ]
}' |
apify call plym-actor-factory/au-qld-ea-permit-reference-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/au-qld-ea-permit-reference-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/aGZynntEEha3qMLYJ/builds/UCvZQP1ERHQR4wak4/openapi.json
