You can access the OpenAPI Breaking Change Detector programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.

Python

JavaScript

CLI

OpenAPI

HTTP

MCP

1import { ApifyClient } from 'apify-client';
2
3// Initialize the ApifyClient with your Apify API token
4// Replace the '<YOUR_API_TOKEN>' with your token
5const client = new ApifyClient({
6    token: '<YOUR_API_TOKEN>',
7});
8
9// Prepare Actor input
10const input = {
11    "beforeUrl": "https://petstore.swagger.io/v2/swagger.json",
12    "afterUrl": "https://petstore3.swagger.io/api/v3/openapi.json"
13};
14
15// Run the Actor and wait for it to finish
16const run = await client.actor("bmiller1009/openapi-breaking-change-detector").call(input);
17
18// Fetch and print Actor results from the run's dataset (if any)
19console.log('Results from dataset');
20console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
21const { items } = await client.dataset(run.defaultDatasetId).listItems();
22items.forEach((item) => {
23    console.dir(item);
24});
25
26// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

OpenAPI Breaking Change Detector — API Contract Diff API in JavaScript

The Apify API client for JavaScript is the official library that allows you to use OpenAPI Breaking Change Detector API in JavaScript or TypeScript, providing convenience functions and automatic retries on errors.

Install the apify-client

$npm install apify-client

Other API clients include:

OpenAPI Breaking Change Detector API in Python

OpenAPI Breaking Change Detector API through CLI

OpenAPI Breaking Change Detector OpenAPI definition

OpenAPI Breaking Change Detector API

Bulk AI Crawler Policy Checker

bmiller1009/bulk-ai-crawler-policy-checker

Check many domains' robots.txt AI crawler policy in one run.

Sentinel Signal

Bulk AI Readiness Scanner

bmiller1009/bulk-ai-readiness-scanner

Score many domains for AI agent readiness in one run.

Sentinel Signal

Third-Party OpenAPI Change Monitor

monema/third-party-openapi-change-monitor

Monitor public OpenAPI and Swagger specifications for structural changes. Get persistent baselines plus review-oriented records for removed operations, new required inputs, response/schema changes, and additive updates.

Maarten Vreeburg

AI Website Intelligence Scanner

bmiller1009/ai-website-intelligence-scanner

Analyze a website's AI readiness, crawler policy, API surface, documentation, and machine-readable structure in one run.

Sentinel Signal

OpenAPI Contract & Breaking Change Monitor

quanmatrix/openapi-breaking-change-monitor

Use this Actor to monitor openapi contract and breaking change changes and return decision-ready change signals. Compare OpenAPI specifications and identify removed paths, methods, parameters, responses, and required-field changes before clients break.

Rafael Barreto Haddad

AI Crawler Access Checker

bmiller1009/ai-crawler-access-checker

Check which known AI crawlers a domain's robots.txt policy allows or blocks.

Sentinel Signal

llms.txt Website Auditor

bmiller1009/llms-txt-website-auditor

Detect and validate a domain's llms.txt (and llms-full.txt), reporting sections, links, and basic structural issues.

Sentinel Signal

Upstream OpenAPI Release Impact Report for Pinned Clients

kingii98/upstream-openapi-release-impact-report-for-pinned-clients

Compare a pinned OpenAPI or Swagger document with the current upstream document. The Actor reports every changed operation and every changed schema with a JSON pointer, the old value, the new value, a change class, and a breaking flag, and it answers one

kingii98

OpenAPI Spec Drift Detector

stellar_ballet_0bu/openapi-spec-drift-detector

Compare two OpenAPI 3.0/3.1 specs (JSON or YAML) and emit per-endpoint / per-operation / per-schema change rows with a `breaking` flag. Pairs with the api-response-delta-monitor.