# Australia ABN Status Portfolio Monitor (`plym-actor-factory/australia-abn-status-portfolio-monitor`) Actor

Watch a list of Australian Business Numbers and emit typed ABN status / GST / entity name+type change events from free official ABR GUID web services. Not CreditorWatch. Not a nationwide ABN dump.

- **URL**: https://apify.com/plym-actor-factory/australia-abn-status-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 abn 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

## Australia ABN Status Portfolio Monitor

Watch a **list of Australian Business Numbers (ABNs)** and receive **typed status / change events** when free official **Australian Business Register (ABR)** fields flip — **ABN cancelled / reactivated**, **GST registered / cancelled**, **entity name**, **entity type**. **Not** another ABR directory scrape. **Not** CreditorWatch / Illion / paid ASIC extracts.

### Honest coverage (read before buying)

| Included (free ABR GUID web services) | **Not** included |
|--------------------------------------|------------------|
| ABN status: Active / Cancelled | Credit scores, payment defaults, court actions (CreditorWatch) |
| GST registration presence + from-date | Historical bulk ABR dumps / nationwide sweeps |
| Entity name + entity type code/name | Director / officeholder registers |
| Lookup by **11-digit ABN** (ATO checksum) on your watchlist only | CreditorWatch HTML or paid APIs |
| Official ABR web services (free GUID registration) | Instant streaming; sub-hour guarantees |

**Live path:** per-ABN poll of official ABR JSON helper / XML SearchByABN (GUID required). First observation stores a **baseline** (no charge). Quiet days ≈ $0 product charges.

**Legal:** Free ABR web services under the published Web Services Agreement (GUID by email). Do **not** treat this as an official ATO/ABR product. Store GUID as a secret input.

### Value proposition

- **ABN watchlist × ABR snapshot diff** → `ABN_CANCELLED`, `ABN_REACTIVATED`, `GST_REGISTERED`, `GST_CANCELLED`, `ENTITY_NAME_CHANGED`, `ENTITY_TYPE_CHANGED`.
- Official free ABR path only. **No CreditorWatch key.**
- **Pay only for unique delivered change events.** Durable KVS checkpoint + `event_uid` dedupe.

### PRODUCTION USE (required for real monitoring)

> **Store default ≠ product.** Schema defaults use `sourceMode=fixture` so Apify Store daily auto-tests leave a non-empty health dataset **without** calling ABR. That fixture path only writes a non-billable `RUN_STATUS` / `FIXTURE_HEALTH` row. It is **not** ABR monitoring.

For **production monitoring** you **must**:

1. Register a free ABR GUID at [ABR Web Services](https://abr.business.gov.au/Tools/WebServices)
2. Set **`sourceMode` = `live`**
3. Set secret input **`abrGuid`**
4. Provide your `abns` watchlist
5. Schedule runs (daily is typical; ABR is not a sub-hour stream)

Official references:

- [ABR web services methods](https://abr.business.gov.au/Documentation/WebServiceMethods)
- [ABR web services registration](https://abr.business.gov.au/Tools/WebServices)
- JSON helper: `https://abr.business.gov.au/json/AbnDetails.aspx?abn={ABN}&guid={GUID}&callback=c`
- XML SearchByABN: `https://abr.business.gov.au/ABRXMLSearch/AbrXmlSearch.asmx/SearchByABNv202001`

**Honest limit:** ABR update-event search is postcode/state scoped for bulk discovery — this Actor **polls watched ABNs** via SearchByABN rather than nationwide update sweeps.

### Apify Store daily auto-test / default input

| Field | Default |
|-------|---------|
| `abns` | `["51824753556","53004085616"]` |
| `signalGroups` | `status`, `gst`, `identity` |
| `sourceMode` | `fixture` |
| `emitFixtureDemoEvents` | `false` |
| `maxRunSeconds` | `55` |
| `requestPaceMs` | `300` |

On that path the Actor **SUCCEEDS** quickly, pushes exactly one `RUN_STATUS` / `FIXTURE_HEALTH` row (`billable: false`), and does **not** charge `abn-status-event-delivered`.

### Input (summary)

| Field | Notes |
|-------|--------|
| `abns` | Watchlist (required, 11-digit ATO checksum) |
| `signalGroups` | `status`, `gst`, `identity` |
| `sourceMode` | `fixture` (default) or `live` |
| `abrGuid` | Secret; required for live |
| `emitFixtureDemoEvents` | Default **false** |
| `asOfHint` | Optional as\_of hint |
| `maxRunSeconds` / `maxEvents` | Budgets |
| `resumeFromCheckpoint` | Default true |
| `requestPaceMs` | Default **300** (raise on 429) |

#### Production example

```json
{
  "abns": ["51824753556", "53004085616", "49004028077"],
  "signalGroups": ["status", "gst", "identity"],
  "sourceMode": "live",
  "abrGuid": "<secret-guid>",
  "asOfHint": "2026-09-16",
  "maxRunSeconds": 300,
  "requestPaceMs": 300,
  "resumeFromCheckpoint": true
}
```

### Output

#### Change events (billable under PPE)

Typed rows include: `abn`, `entity_name`, `event_type`, `event_subtype`, `changed_fields`, `previous_value`, `new_value`, `as_of`, `evidence`, `summary`, `source_url`, `event_uid`, `entity_type_code`, `billable: true`.

#### RUN\_STATUS (never billed)

Every successful run pushes one health row (`FIXTURE_HEALTH` | `MONITOR_IDLE` | `CATCHUP_COMPLETE` | `HEALTH_OK`).

### Pricing

Pay-per-event: **`abn-status-event-delivered`** at **$0.02** per delivered unique change event ($20 / 1,000). Single tier (see `docs/monetization.md` and ADR 0010). Health / baseline / duplicate / fixture rows are never charged.

### Local development

```bash
cd actors/australia-abn-status-portfolio-monitor
npm install
npm test
npm run build
apify run -p
```

### Attribution

Data originates from the **Australian Business Register** via free official web services. Not an official ATO/ABR product. Not CreditorWatch.

# Actor input Schema

## `abns` (type: `array`):

Australian Business Numbers (11 digits, ATO checksum) to monitor via free official ABR GUID web services. Invalid entries are skipped with no charge. Not a nationwide dump — only these ABNs are polled.

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

Which change groups to evaluate: status (ABN active/cancelled), gst (GST registered/cancelled), identity (entity name / type). Default: all.

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

Wall-clock budget for the run. Large books may need longer budgets or chunked schedules.

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

Stop after this many unique change events are delivered (does not include RUN\_STATUS).

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

If true, resume ABN 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 free ABR GUID web services (SearchByABN poll). Not CreditorWatch.

## `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 change events or charge abn-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. To see them, set Source mode = fixture and put the placeholder values 72999999991, 53999999992, 34999999993 in "ABNs (watchlist)".

## `abrGuid` (type: `string`):

Free authentication GUID from abr.business.gov.au/Tools/WebServices (register once by email). Required for sourceMode=live. Stored as a secret — never logged. Not a CreditorWatch key.

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

Optional as\_of label for events / RUN\_STATUS. Does not change ABR polling behaviour.

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

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

## `requestPaceMs` (type: `integer`):

Minimum delay between outbound ABR HTTP requests. Default 300 ms (fair-use). Raise if you see 429s.

## Actor input object example

```json
{
  "abns": [
    "51824753556",
    "53004085616"
  ],
  "signalGroups": [
    "status",
    "gst",
    "identity"
  ],
  "maxRunSeconds": 55,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false,
  "requestPaceMs": 300
}
```

# Actor output Schema

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

JSON summary: delivered, charged, runStatus, checkpoint, stats, ABR 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/australia-abn-status-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/australia-abn-status-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/australia-abn-status-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/australia-abn-status-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/7NhJ1iJnXfsux3gc0/builds/gF7nogIdATEKrvup4/openapi.json