# OpenAPI Change Monitor (`prophed/openapi-change-monitor`) Actor

Monitor OpenAPI JSON/YAML specifications and output structured breaking/non-breaking API change records.

- **URL**: https://apify.com/prophed/openapi-change-monitor.md
- **Developed by:** [Prophed Com](https://apify.com/prophed) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$1.00 / 1,000 dataset items

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/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.
Actors are written with capital "A".

## 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.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## OpenAPI Change Monitor

Monitor public OpenAPI JSON/YAML specifications and receive structured change records in an Apify dataset.

### Why use it

API consumers, integration teams, developer-tool vendors, and automation teams need early warning when an API surface changes. This Actor turns OpenAPI specs into scheduled, dataset-friendly change records that can feed alerts, QA checks, dashboards, and integration maintenance workflows.

### What it detects

- Added operations
- Removed operations
- Changed operations
- Added required parameters
- Removed response codes
- Request content-type changes
- Fetch and parse errors
- Optional unchanged/baseline rows

### Input

```json
{
  "specs": [
    {
      "name": "APIs.guru",
      "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json"
    }
  ],
  "includeUnchanged": false,
  "storeBaseline": true,
  "compareKeyPrefix": "openapi-change-monitor",
  "maxSpecs": 25
}
```

### Output

Each dataset item is one finding:

```json
{
  "specName": "Example API",
  "specUrl": "https://example.com/openapi.json",
  "changeType": "changed",
  "severity": "breaking",
  "method": "GET",
  "path": "/users",
  "operationId": "listUsers",
  "details": {
    "addedRequiredParameters": ["query:tenant"],
    "removedResponses": ["200"],
    "requestContentTypesChanged": false
  },
  "detectedAt": "2026-07-05T00:00:00.000Z"
}
```

### Typical workflows

- Schedule a daily run for public partner APIs.
- Send breaking-change rows to Slack, email, Zapier, Make, or a webhook.
- Keep a baseline in the Actor key-value store and compare each new run against it.
- Monitor multiple specs in one batch while keeping `maxSpecs` capped for cost control.

### Notes

This Actor only processes spec URLs supplied by the user. Users are responsible for permission to monitor any private or non-public specification URL they provide.

# Actor input Schema

## `specs` (type: `array`):

Public OpenAPI JSON/YAML URLs to monitor.

## `compareKeyPrefix` (type: `string`):

Prefix used for persistent baseline storage in the Actor key-value store.

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

Emit one dataset row for specs that did not change.

## `storeBaseline` (type: `boolean`):

Persist the latest operation fingerprint baseline after each successful fetch.

## `maxSpecs` (type: `integer`):

Hard cap to control runtime cost.

## Actor input object example

```json
{
  "specs": [
    {
      "name": "Example API",
      "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json"
    }
  ],
  "compareKeyPrefix": "openapi-change-monitor",
  "includeUnchanged": false,
  "storeBaseline": true,
  "maxSpecs": 25
}
```

# Actor output Schema

## `results` (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 = {
    "specs": [
        {
            "name": "Example API",
            "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json"
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("prophed/openapi-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 = { "specs": [{
            "name": "Example API",
            "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json",
        }] }

# Run the Actor and wait for it to finish
run = client.actor("prophed/openapi-change-monitor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "specs": [
    {
      "name": "Example API",
      "url": "https://api.apis.guru/v2/specs/apis.guru/2.2.0/openapi.json"
    }
  ]
}' |
apify call prophed/openapi-change-monitor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=prophed/openapi-change-monitor",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/KY0q3jPaleTfTUjw3/builds/cmCyN3Se7eqIf0fxb/openapi.json