# UK Open Banking API Diff & Breaking Changes (`minsun-jung-ai/uk-open-banking-openapi-change-intelligence`) Actor

Compare the latest stable UK Open Banking API versions and detect breaking and non-breaking OpenAPI changes automatically. Returns machine-readable diffs for developers, CI/CD pipelines, and AI agents.

- **URL**: https://apify.com/minsun-jung-ai/uk-open-banking-openapi-change-intelligence.md
- **Developed by:** [Minsun Jung](https://apify.com/minsun-jung-ai) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $250.00 / 1,000 openapi release comparisons

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

## UK Open Banking API Diff & Breaking Changes

Compare the latest stable **UK Open Banking API versions** and detect **breaking and non-breaking OpenAPI changes** automatically.

Use this Actor when you need a machine-readable **Open Banking API changelog**, want to **compare API versions**, or need an **OpenAPI diff / breaking change detector** without manually downloading and comparing specification files.

### What it does

The Actor fetches the official OpenBankingUK `read-write-api-specs` releases and published OpenAPI JSON files, selects the two latest stable releases, compares them automatically, and returns:

- release metadata (`from_ref`, `to_ref`, publication dates, evidence URL)
- added/removed API operations
- added/removed schemas
- added/removed object properties
- fields that became required or optional
- enum values added or removed
- a deterministic compatibility heuristic marking potentially breaking changes

In other words: instead of finding two UK Open Banking specification versions and running a generic OpenAPI diff yourself, this Actor resolves the current stable releases and produces the comparison in one run.

A live Apify smoke test on 2026-09-24 compared the then-latest stable releases `v4.0.1 -> v4.0.1-Update-1` and returned **12 structural changes**, including **3 potentially breaking changes** under the current heuristic. Counts vary as upstream releases change.

### Input

```json
{
  "onlyBreaking": false,
  "maxChanges": 100
}
```

- `onlyBreaking`: return only potentially breaking structural changes.
- `maxChanges`: maximum detailed changes to include in the comparison result (1–500).

### Dataset output

Each run writes **one comparison result** to the default dataset. That single visible result maps to one `release-comparison` pay-per-event charge.

Example shape:

```json
{
  "product": "UK Open Banking OpenAPI Change Intelligence",
  "sourceId": "uk_ob_read_write_api",
  "comparison": {
    "from_ref": "v4.0.1",
    "to_ref": "v4.0.1-Update-1"
  },
  "summary": {
    "total_changes": 12,
    "breaking_changes": 3
  },
  "returnedChangeCount": 12,
  "onlyBreaking": false,
  "changes": [
    {
      "kind": "schema_removed",
      "file": "account-info-openapi.json",
      "target": "OBAddressTypeCode",
      "breaking": true,
      "detail": {}
    }
  ]
}
```

### Pricing intent

One successful visible comparison result is one `release-comparison` pay-per-event charge. The validation price is **$0.25 per comparison**. Platform usage is included in the event price.

### Evidence and limitations

This Actor is deterministic: the structural diff is derived directly from official OpenAPI files. It does not ask an LLM to invent impacts.

`breaking=true` is a compatibility heuristic, **not legal advice and not a substitute for implementation testing or the official release notes**. Description-only/textual changes may not be classified by the structural comparator.

### Source and reuse

Source: Open Banking Limited Read/Write API specifications (`OpenBankingUK/read-write-api-specs`). Open Banking Limited's Open Licence states that specifications are made available under the MIT licence unless otherwise stated. Retain applicable licence/copyright notices when redistributing substantial portions.

This product is an independent change-intelligence tool and is not endorsed by Open Banking Limited.

# Actor input Schema

## `onlyBreaking` (type: `boolean`):

Return only changes classified as potentially breaking by the structural compatibility heuristic.

## `maxChanges` (type: `integer`):

Maximum number of detailed change records to include in the dataset output.

## Actor input object example

```json
{
  "onlyBreaking": false,
  "maxChanges": 100
}
```

# 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 = {};

// Run the Actor and wait for it to finish
const run = await client.actor("minsun-jung-ai/uk-open-banking-openapi-change-intelligence").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("minsun-jung-ai/uk-open-banking-openapi-change-intelligence").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 minsun-jung-ai/uk-open-banking-openapi-change-intelligence --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,minsun-jung-ai/uk-open-banking-openapi-change-intelligence"
        }
    }
}
```

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/mEIPwU84MJ4mrLmLh/builds/QHXydxAwPwqtU9vwx/openapi.json