# CKAN Resource Link Change Monitor (`quietdatatools/ckan-resource-link-change-monitor`) Actor

Track CKAN resource download URL, format, MIME type, hash, size and DataStore metadata changes. Flag missing required resource IDs for open-data pipelines. Failed checks preserve history.

- **URL**: https://apify.com/quietdatatools/ckan-resource-link-change-monitor.md
- **Developed by:** [QuietDataTools](https://apify.com/quietdatatools) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$0.01 / successful manifest check

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

## CKAN Resource Link Change Monitor

Keep CKAN download manifests current. Monitor one public dataset for resource URL, format, MIME type, name, reported hash/size and DataStore availability changes. Stable resource IDs distinguish a renamed or moved download from replacement resources. Exact required resource IDs flag a missing input to your pipeline.

Useful for open-data ingestion, catalog maintenance and scheduled ETL preflight. It reads package metadata only and never downloads the resource files or dataset rows.

### Quick start

```json
{"portalUrl":"https://open.canada.ca/data/en","datasetId":"09ffaeb5-ec8f-5bb5-bdcb-3436ccf26f58","monitorName":"default","requiredResourceIds":[],"includeUnchanged":true}
```

The example is Canada's Climatic Regions dataset. Other HTTPS CKAN portals and portal subpaths are supported if they expose the standard public `api/3/action/package_show` endpoint. This is CKAN only; data.gov's successor API, Socrata and DCAT-only catalogs are different protocols.

First check returns BASELINE. Later checks return ADDED, CHANGED, UNCHANGED or NO_LONGER_LISTED. Each row includes exact previous/current metadata, changed fields, source URL and check time. NO_LONGER_LISTED means absent from a successfully read manifest; it does not prove the underlying file was deleted. The OUTPUT summary includes resource counts, missing required IDs and the prior check time. Suppress unchanged rows without suppressing successful check summaries.

### Pricing

$0.01 per successful manifest check, including baseline, empty manifest and unchanged checks. Platform usage is included. Failed source/validation checks do not emit the successful-check charge and preserve the last good snapshot. One dataset per run. Use an Apify schedule and consume the default dataset/OUTPUT in your workflow; the Actor does not send messages itself.

### Boundaries

- Public HTTPS metadata only; no credentials, cookies, custom headers, proxies or gated datasets. DNS is checked for public addresses and pinned for each request; only same-origin redirects are permitted.
- 2 MB, 20-second source deadline, at most 1,000 resources and 100 required IDs. Incomplete, duplicate, mismatched or inactive source records fail rather than inventing removals.
- Resource URLs and hashes are source-reported strings. No link reachability, byte integrity, license, freshness or downstream compatibility certification. Empty/missing hash and format are kept distinct. Timestamp-only updates are ignored.
- History is isolated by user, Actor, portal, requested dataset and monitor name. A slug retargeting to another dataset ID fails; choose a new monitor name deliberately. A new input dataset/URL is a separate history.
- Schedule one concurrent run per monitor. The lease is best effort and non-atomic. Interrupted delivery/billing/history writes can repeat output or charges on retry (at-least-once behavior).
- Portal extensions can alter field shapes. Unsupported metadata fails safely. Check the dataset's own license and source terms before using its data.

The Apify SDK retains a transitive http-cache-semantics advisory with no upstream patch at release. The Actor's source client uses native HTTPS, no credentials and no application shared cache; this does not claim the SDK dependency is cleared. Source and fixture tests are retained privately in the cloud project.

# Actor input Schema

## `portalUrl` (type: `string`):

Public HTTPS CKAN portal root or subpath; no query, credentials or fragment.

## `datasetId` (type: `string`):

Exact public active CKAN dataset UUID or slug.

## `monitorName` (type: `string`):

History identity. Change deliberately to start a new baseline. One concurrent run per monitor.

## `requiredResourceIds` (type: `array`):

Exact resource IDs whose absence is reported in the summary. Maximum 100.

## `includeUnchanged` (type: `boolean`):

Keep unchanged rows in the dataset. Successful unchanged checks are charged regardless.

## Actor input object example

```json
{
  "portalUrl": "https://open.canada.ca/data/en",
  "datasetId": "09ffaeb5-ec8f-5bb5-bdcb-3436ccf26f58",
  "monitorName": "default",
  "requiredResourceIds": [],
  "includeUnchanged": true
}
```

# Actor output Schema

## `resources` (type: `string`):

No description

## `summary` (type: `string`):

No description

# 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 = {
    "portalUrl": "https://open.canada.ca/data/en",
    "datasetId": "09ffaeb5-ec8f-5bb5-bdcb-3436ccf26f58"
};

// Run the Actor and wait for it to finish
const run = await client.actor("quietdatatools/ckan-resource-link-change-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 = {
    "portalUrl": "https://open.canada.ca/data/en",
    "datasetId": "09ffaeb5-ec8f-5bb5-bdcb-3436ccf26f58",
}

# Run the Actor and wait for it to finish
run = client.actor("quietdatatools/ckan-resource-link-change-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 '{
  "portalUrl": "https://open.canada.ca/data/en",
  "datasetId": "09ffaeb5-ec8f-5bb5-bdcb-3436ccf26f58"
}' |
apify call quietdatatools/ckan-resource-link-change-monitor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,quietdatatools/ckan-resource-link-change-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/ZsdA9W8qC8nvuiEK2/builds/LbWnevE2pI31NtYPe/openapi.json
