# PyPI Breaking Changes Between Versions

> PyPI Breaking Changes Between Versions is a paid API for AI agents from upgrade-brief.shopttyass-85f.workers.dev, paid per call via x402, $0.005/call, status unknown (last checked 2026-10-28).

Returns documented breaking changes, manifest diffs, and a compatibility verdict for a Python package upgrade between two PyPI versions

## Facts

- Endpoint: GET https://upgrade-brief.shopttyass-85f.workers.dev/pypi/breaking-changes?utm_source=zero.xyz
- Price: $0.005/call
- Payment: x402
- Status: unknown
- Last checked: 2026-10-28
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/pypi-breaking-changes-between-versions-3da8ead3
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_oCx3qcVrHZ4ka6lnxGY1R

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability pypi-breaking-changes-between-versions-3da8ead3
```

Example prompt: Before I upgrade pydantic from version 1.10.13 to 2.0, can you pull the documented breaking changes, any Python version requirement shifts, and an overall verdict on whether the upgrade is safe?

## When to prefer this

Use this endpoint when you need a structured, sourced summary of breaking changes for a Python package upgrade — especially for major version bumps where manual changelog review would be tedious. Prefer this over reading raw changelogs when you need a machine-readable verdict, manifest diffs (Requires-Python, dependency changes), and per-version sourcing in one call. Choose this over the sibling PyPI Changelog endpoint when you only care about breaking changes and compatibility, not the full release notes narrative.

## Known failure modes

- Package not found on PyPI — returns error or empty result
- From or to version not resolvable — returns error if version prefix matches no stable release
- No changelog or release notes found — verdict becomes UNKNOWN_INCOMPLETE_NOTES with degraded flag
- Yanked versions in range flagged but may cause unexpected version resolution
- Rate limiting or upstream GitHub/PyPI unavailability may degrade coverage
- Invalid version string format returns a validation error

## How this service works

PyPI breaking changes between two versions of a Python package, before a pip package upgrade: the documented breaking changes per version from the project's CHANGELOG, HISTORY or CHANGES file and GitHub release notes (alpha/beta/rc folded into the major), plus Requires-Python and required dependency changes, yanked versions, migration guide links and a verdict. PEP 440 versions ('1.10.13', '2.0') or a major ('1'); a source URL for every item.

## Output

A JSON object containing: a verdict enum (BREAKING_CHANGES_LIKELY, REVIEW_MANIFEST_CHANGES, NO_BREAKING_CHANGES_DOCUMENTED, UNKNOWN_INCOMPLETE_NOTES), a human-readable summary, a list of breaking change items per version with source URLs and publish dates, manifest changes (Requires-Python diff, added/removed/changed dependencies), coverage stats showing which versions have release notes, migration guide links, yanked version warnings, the latest stable version, and the repository URL.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "required": [
  "input"
 ],
 "properties": {
  "input": {
   "type": "object",
   "required": [
    "type",
    "method"
   ],
   "properties": {
    "type": {
     "type": "string",
     "const": "http"
    },
    "method": {
     "enum": [
      "GET"
     ],
     "type": "string"
    },
    "queryParams": {
     "type": "object",
     "required": [
      "package",
      "from"
     ],
     "properties": {
      "to": {
       "type": "string",
       "default": "latest",
       "description": "Target version: exact, or a major/minor prefix ('5', '5.1') resolved to the first stable release of that series (5.0.0). Default: the latest stable release ('latest')"
      },
      "from": {
       "type": "string",
       "description": "Version you are on now: exact ('1.10.13', '2.0'), or a major/minor prefix ('1', '4.2') resolved to its newest stable release (PEP 440)"
      },
      "package": {
       "type": "string",
       "description": "PyPI project name, e.g. 'pydantic', 'django' or 'flask'"
      },
      "prereleases": {
       "enum": [
        "true",
        "false"
       ],
       "type": "string",
       "default": "false",
       "description": "Include alpha/beta/rc/canary versions in the range"
      }
     },
     "additionalProperties": false
    }
   },
   "additionalProperties": false
  },
  "output": {
   "type": "object",
   "required": [
    "type"
   ],
   "properties": {
    "type": {
     "type": "string"
    },
    "example": {
     "type": "object",
     "required": [
      "package",
      "from",
      "to",
      "verdict",
      "summary",
      "breaking"
     ],
     "properties": {
      "to": {
       "type": "string"
      },
      "asOf": {
       "type": "string"
      },
      "from": {
       "type": "string"
      },
      "notes": {
       "type": "array",
       "items": {
        "type": "string"
       }
      },
      "latest": {
       "type": [
        "string",
        "null"
       ],
       "description": "Latest stable version"
      },
      "package": {
       "type": "string"
      },
      "sources": {
       "type": "array",
       "items": {
        "type": "string"
       }
      },
      "summary": {
       "type": "string"
      },
      "verdict": {
       "enum": [
        "BREAKING_CHANGES_LIKELY",
        "REVIEW_MANIFEST_CHANGES",
        "NO_BREAKING_CHANGES_DOCUMENTED",
        "UNKNOWN_INCOMPLETE_NOTES"
  
… (truncated)
```

## Response schema (JSON Schema)

```json
{
 "type": "json",
 "example": {
  "to": "2.32.0",
  "from": "2.31.0",
  "latest": "2.34.2",
  "package": "requests",
  "summary": "requests 2.31.0 -> 2.32.0: 1 versions, 0 major bump(s), 2 documented breaking item(s) in 1 version(s); release notes found for 1/1 versions. Manifest: Python requirement changed: >=3.7 -> >=3.8.",
  "verdict": "BREAKING_CHANGES_LIKELY",
  "breaking": [
   {
    "bump": "minor",
    "items": [
     "Requests has officially dropped support for CPython 3.7",
     "Requests has officially dropped support for PyPy 3.7 and 3.8"
    ],
    "source": "https://github.com/psf/requests/blob/HEAD/HISTORY.md",
    "version": "2.32.0",
    "publishedAt": "2024-05-20T00:00:00Z"
   }
  ],
  "coverage": {
   "versionsWithNotes": 1,
   "versionsWithoutNotes": []
  },
  "degraded": false,
  "ecosystem": "pypi",
  "majorBumps": [],
  "repository": "https://github.com/psf/requests",
  "manifestChanges": {
   "flags": [
    "Python requirement changed: >=3.7 -> >=3.8"
   ],
   "dependencies": {
    "added": {},
    "changed": {},
    "removed": []
   },
   "requiresPython": {
    "to": ">=3.8",
    "from": ">=3.7"
   }
  },
  "migrationGuides": [],
  "versionsInRange": 1
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/pypi-breaking-changes-between-versions-3da8ead3/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from upgrade-brief.shopttyass-85f.workers.dev](https://www.zero.xyz/host/upgrade-brief.shopttyass-85f.workers.dev/llms.txt)