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

{
  "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:

{
  "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.