# GBIF Dataset Endpoint & License Monitor (`quietdatatools/gbif-dataset-endpoint-license-monitor`) Actor

Monitor a GBIF dataset for endpoint additions, removals, URL changes, license changes and logical deletion. Get structured before/after changes with persistent history. Failed source checks preserve the previous snapshot.

- **URL**: https://apify.com/quietdatatools/gbif-dataset-endpoint-license-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

$10.00 / 1,000 successful dataset checks

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

## GBIF Dataset Endpoint & License Monitor

Watch one registered GBIF dataset for exact endpoint URL/type changes, additions/removals, license changes, publisher changes, DOI changes, title/type changes and a logical deletion timestamp. Built for biodiversity data pipelines and research data inventories that need a durable before/after record rather than another occurrence search.

### Input

```json
{"datasetKey":"50c9509d-22c7-4a22-a47d-8c48425ef4a7","monitorName":"default","includeUnchanged":true}
```

Use the UUID from a GBIF dataset page. Keep monitorName stable; a different name starts a separate baseline. Save as an Apify Task and schedule it to monitor repeatedly.

### Output

Every successful check writes OUTPUT and by default one dataset row: BASELINE, CHANGED or UNCHANGED, with checkedAt, previousCheckedAt, changes, current and previous snapshots. Endpoint identity uses GBIF endpoint keys; ordering does not create changes. Warnings flag DATASET_MARKED_DELETED, LICENSE_UNSPECIFIED and NO_REGISTERED_ENDPOINTS. No contacts, emails, occurrence locations or full dataset files are collected.

GBIF logical deletion is a metadata timestamp; a 404, incomplete response or malformed endpoint fails the check and preserves prior history. A registered endpoint is not proof its download works: endpoint URLs are recorded but never fetched. Dataset license metadata is not a legal assessment of individual occurrence/media rights. Review source terms and citation requirements.

### Pricing

$0.01 per successful dataset check, including baseline and unchanged checks. Platform usage included. Failed checks are not charged. includeUnchanged=false suppresses unchanged dataset rows but OUTPUT is still written and the check is still charged. Set maximum charge to at least $0.01.

### Reliability and limits

Fixed official api.gbif.org source only, one UUID, 2MB response cap, 20-second deadline, no redirects or retries, at most1000 endpoints. Defaults256MB/60seconds; restart and standby off. No API key, paid proxy or external account required. History is isolated by user, Actor, dataset and monitor. A best-effort five-minute lease rejects overlap; it is not an atomic storage lock, so schedule each monitor sequentially. Output is delivered before charging; history commits only after a successful charge. Interrupted output/charge/commit can cause repeated output or charges on retry. Storage retention or deleting history starts a new baseline.

### Sources and support

Official API: https://techdocs.gbif.org/en/openapi/v1/registry-principal-methods
Citation: https://www.gbif.org/citation-guidelines
QuietDataTools is not affiliated with GBIF. Use the official free API directly if you do not need stateful monitoring. No revenue or demand guarantee. Report the dataset UUID and run ID in Issues without credentials.

# Actor input Schema

## `datasetKey` (type: `string`):

Dataset key from its GBIF page. One exact dataset per check.

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

Keep stable for history; change to start a baseline.

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

Unchanged checks are still charged when rows are suppressed; OUTPUT is always written.

## Actor input object example

```json
{
  "datasetKey": "50c9509d-22c7-4a22-a47d-8c48425ef4a7",
  "monitorName": "default",
  "includeUnchanged": true
}
```

# Actor output Schema

## `results` (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 = {
    "datasetKey": "50c9509d-22c7-4a22-a47d-8c48425ef4a7"
};

// Run the Actor and wait for it to finish
const run = await client.actor("quietdatatools/gbif-dataset-endpoint-license-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 = { "datasetKey": "50c9509d-22c7-4a22-a47d-8c48425ef4a7" }

# Run the Actor and wait for it to finish
run = client.actor("quietdatatools/gbif-dataset-endpoint-license-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 '{
  "datasetKey": "50c9509d-22c7-4a22-a47d-8c48425ef4a7"
}' |
apify call quietdatatools/gbif-dataset-endpoint-license-monitor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,quietdatatools/gbif-dataset-endpoint-license-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/qlfKlvwxuVFXXjVOO/builds/fYAYsfpx6bf99unjJ/openapi.json
