# Finland PRH Y-tunnus Portfolio Status Monitor (`plym-actor-factory/finland-prh-ytunnus-portfolio-monitor`) Actor

Watch a list of Finnish Y-tunnukset and emit typed Business-ID / trade-register / konkurssi / saneeraus / selvitystila / name events from free official PRH YTJ open data (avoindata.prh.fi). Not a Finder.fi dump; not Asiakastieto.

- **URL**: https://apify.com/plym-actor-factory/finland-prh-ytunnus-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 prh 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

## Finland PRH Y-tunnus Portfolio Status Monitor

Watch a **list of Finnish Y-tunnukset** (suppliers, customers, counterparties) and receive **typed status / change events** when free official **PRH / YTJ open data** fields flip — **Business ID status**, **Trade Register status**, **konkurssi / saneeraus / selvitystila**, **name**, **endDate**. **Not** another Finder.fi directory scrape. **Not** Asiakastieto / Virre paid seats.

### Honest coverage (read before buying)

| Included (free PRH open data) | **Not** included |
|-------------------------------|------------------|
| Business ID status (`STATUS3`: Pending / Valid / Invalidated) | Finder.fi HTML scrapes |
| Trade Register status (`tradeRegisterStatus`) | Asiakastieto Critical Alerts! / Tietovahti seats |
| `companySituations`: KONK / SANE / SELTILA | Nationwide new-OY lead dumps |
| Current legal name + optional endDate | Instant streaming; sub-hour guarantees |
| Lookup by **Y-tunnus** on your watchlist only | Some entity forms excluded by PRH open data |

**Live path:** per-ID `GET https://avoindata.prh.fi/opendata-ytj-api/v3/companies?businessId={ytunnus}`. Open data updates **about once daily**. First observation stores a **baseline** (no charge). Quiet days ≈ $0 product charges.

**Legal:** PRH open data expressly free for reuse; no registration/key for the public YTJ open API. Do **not** treat this as an official PRH product. Default product = Business ID + trade-register status + published insolvency situation codes + name.

### Value proposition

- **Y-tunnus watchlist × PRH snapshot diff** → `FI_YTUNNUS_STATUS_CHANGED`, `FI_TRADE_REGISTER_STATUS_CHANGED`, `FI_KONKURSSI`, `FI_SANEERAUS`, `FI_SELVITYSTILA`, `FI_NAME_CHANGED`, `FI_END_DATE_SET`, `FI_GONE` (+ clear variants).
- Official free open data only. **No Asiakastieto / Finder / Virre 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 PRH. That fixture path only writes a non-billable `RUN_STATUS` / `FIXTURE_HEALTH` row. It is **not** PRH monitoring.

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

1. Set **`sourceMode` = `live`**
2. Provide your `businessIds` watchlist (Y-tunnukset)
3. Schedule runs (daily is typical; PRH open data is not a sub-hour stream)
4. Optionally set `asOfHint` (YYYY-MM-DD)

Official references:

- [YTJ open data API schema](https://avoindata.prh.fi/opendata-ytj-api/v3/schema?lang=en)
- [PRH open data](https://avoindata.prh.fi/en)
- Endpoint: `https://avoindata.prh.fi/opendata-ytj-api/v3/companies?businessId={businessId}`

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

| Field | Default |
|-------|---------|
| `businessIds` | `["0116297-6","0112038-9"]` |
| `signalGroups` | `insolvency`, `status`, `identity` |
| `sourceMode` | `fixture` |
| `emitFixtureDemoEvents` | `false` |
| `maxRunSeconds` | `55` |
| `requestPaceMs` | `250` |

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

### Input (summary)

| Field | Notes |
|-------|--------|
| `businessIds` | Watchlist (required, Y-tunnus NNNNNNN-C) |
| `signalGroups` | `insolvency`, `status`, `identity` |
| `sourceMode` | `fixture` (default) or `live` |
| `emitFixtureDemoEvents` | Default **false** |
| `asOfHint` | Optional as\_of hint |
| `maxRunSeconds` / `maxEvents` | Budgets |
| `resumeFromCheckpoint` | Default true |
| `requestPaceMs` | Default **250** (raise on 429) |

#### Production example

```json
{
  "businessIds": ["0116297-6", "0112038-9", "0210161-4"],
  "signalGroups": ["insolvency", "status", "identity"],
  "sourceMode": "live",
  "asOfHint": "2026-09-17",
  "maxRunSeconds": 300,
  "requestPaceMs": 250,
  "resumeFromCheckpoint": true
}
```

### Output

#### Change events (billable under PPE)

Typed rows include: `business_id`, `legal_name`, `event_type`, `event_subtype`, `changed_fields`, `previous_value`, `new_value`, `as_of`, `evidence`, `summary`, `source_url`, `event_uid`, `company_form`, `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: **`prh-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/finland-prh-ytunnus-portfolio-monitor
npm install
npm test
npm run build
apify run -p
```

### Attribution

Data originates from **Patentti- ja rekisterihallitus (PRH)** / **YTJ** open data. Not an official PRH product. Not Finder.fi / Asiakastieto / Virre.

# Actor input Schema

## `businessIds` (type: `array`):

Finnish Business IDs (Y-tunnus, format NNNNNNN-C with official check digit) to monitor via free official PRH/YTJ open data API. Invalid entries are skipped with no charge. Not a nationwide dump — only these IDs are polled.

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

Which change groups to evaluate: insolvency (konkurssi / saneeraus / selvitystila), status (Business ID status / trade-register status / endDate / gone), identity (legal name). 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 Y-tunnus 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 PRH YTJ open data API (avoindata.prh.fi; no key). Not Finder.fi; not Asiakastieto / Virre paid APIs.

## `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 prh-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 9999999-2, 9999998-4, 9999997-6 in "Y-tunnukset (watchlist)".

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

Optional as\_of label for events / RUN\_STATUS. PRH open data updates about once daily; this does not force a bulk ZIP download.

## `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 PRH HTTP requests. Default 250 ms (fair-use). Raise if you see 429s.

## Actor input object example

```json
{
  "businessIds": [
    "0116297-6",
    "0112038-9"
  ],
  "signalGroups": [
    "insolvency",
    "status",
    "identity"
  ],
  "maxRunSeconds": 55,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false,
  "requestPaceMs": 250
}
```

# Actor output Schema

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

JSON summary: delivered, charged, runStatus, checkpoint, stats, PRH 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/finland-prh-ytunnus-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/finland-prh-ytunnus-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/finland-prh-ytunnus-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/finland-prh-ytunnus-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/llZVuannjgf1qjDE7/builds/pAqqivbCXRf7IEIME/openapi.json