# PyPI Release Monitor API (`automly/pypi-release-monitor-api`) Actor Monitor PyPI releases and package metadata from the public PyPI JSON API. - **URL**: https://apify.com/automly/pypi-release-monitor-api.md - **Developed by:** [Automly](https://apify.com/automly) (community) - **Categories:** Developer tools - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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 ## PyPI Release Monitor API **PyPI Release Monitor API** collects clean, structured PyPI release data for one or more Python packages. Use it to track new versions, monitor dependency updates, and feed package metadata into alerts, dashboards, or automation workflows. ### Why use this PyPI release monitor? Python dependencies move quickly, and a small release can still affect compatibility, security, or deployment plans. This actor gives you a simple way to track PyPI packages without building and maintaining custom polling logic. Typical use cases: - Track release cadence for critical Python dependencies - Watch for version bumps in your runtime stack - Power alerts, dashboards, and changelog workflows - Enrich engineering data pipelines with package metadata ### Features - Monitor one or more PyPI packages in a single run - Return either a compact latest-release summary or individual recent version records - Include package metadata, release timestamps, authors, license, and Python version requirements - Pay-per-event pricing tied to the records you actually use ### Input #### Example: quick latest-release check ```json { "packages": "requests, fastapi, numpy", "latestOnly": true, "maxResults": 5, "versionsPerPackage": 10 } ```` #### Example: recent version monitoring ```json { "packages": "pydantic, uvicorn", "latestOnly": false, "maxResults": 20, "versionsPerPackage": 5 } ``` #### Input fields | Field | Type | Description | |---|---|---| | `packages` | string | Comma or newline separated PyPI package names to monitor, such as `requests`, `fastapi`, or `numpy`. | | `latestOnly` | boolean | When enabled, returns one summary record per package instead of recent version records. | | `maxResults` | integer | Maximum number of dataset records to return across all packages. Values above 100 are clamped. | | `versionsPerPackage` | integer | How many recent versions to include for each package when `latestOnly` is turned off. Values above 50 are clamped. | ### Output #### Example record: latest-release summary ```json { "packageName": "requests", "version": "2.32.3", "latestVersion": "2.32.3", "summary": "Python HTTP for Humans.", "description": "Python HTTP for Humans.", "homepageUrl": "https://requests.readthedocs.io", "sourceCodeUrl": "https://github.com/psf/requests", "documentationUrl": null, "packageUrl": "https://pypi.org/project/requests/", "author": "Kenneth Reitz", "authorEmail": "me@kennethreitz.org", "license": "Apache-2.0", "requiresPython": ">=3.9", "publishedAt": "2024-05-20T12:00:00.000Z", "yanked": false, "yankedReason": null, "releaseFileCount": 2, "releaseCount": 138, "recordType": "package_summary" } ``` #### Example record: version detail ```json { "packageName": "fastapi", "version": "0.115.0", "latestVersion": "0.115.0", "summary": "FastAPI framework", "description": "FastAPI framework", "homepageUrl": "https://fastapi.tiangolo.com", "sourceCodeUrl": "https://github.com/fastapi/fastapi", "documentationUrl": null, "packageUrl": "https://pypi.org/project/fastapi/", "author": "Sebastián Ramírez", "authorEmail": "", "license": "MIT", "requiresPython": ">=3.8", "publishedAt": "2024-09-01T12:00:00.000Z", "yanked": false, "yankedReason": null, "releaseFileCount": 1, "releaseCount": 90, "recordType": "version_record" } ``` ### Limits and caveats - Package names must point to public PyPI packages. - If a package has many releases, use `latestOnly=true` for a cheaper summary run. - `maxResults` is capped at 100 to keep runs predictable and affordable. - `versionsPerPackage` is capped at 50 so detail runs stay fast. - Some packages leave metadata fields blank, so not every field will be populated for every release. ### Pricing This actor uses **Pay-Per-Event** pricing. | Event | Price | Charged when | |---|---:|---| | `package-summary-produced` | $0.25 / 1k | A latest-release summary record is produced | | `version-record-produced` | $0.75 / 1k | An individual version record is produced | ### FAQ **Do I need a PyPI account?**\ No. The actor reads public PyPI metadata. **What is the difference between summary mode and detail mode?**\ Summary mode returns one record per package using the latest release. Detail mode returns recent versions as separate records. **Can I use this for dependency monitoring?**\ Yes. Re-run the actor on a schedule and compare version changes over time. **What if a package does not exist?**\ The actor skips invalid package names and continues with the rest of the list. # Actor input Schema ## `packages` (type: `string`): Comma or newline separated PyPI package names to monitor, such as requests, fastapi, or numpy. ## `latestOnly` (type: `boolean`): When enabled, return one summary record per package instead of recent version records. ## `maxResults` (type: `integer`): Maximum number of dataset records to return across all packages. Values above 100 are clamped. ## `versionsPerPackage` (type: `integer`): How many recent versions to include for each package when latest only is disabled. Values above 50 are clamped. ## Actor input object example ```json { "latestOnly": true, "maxResults": 100, "versionsPerPackage": 10 } ``` # Actor output Schema ## `records` (type: `string`): All records produced by this run. ## `overview` (type: `string`): Dataset presented with the default overview view. # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("automly/pypi-release-monitor-api").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("automly/pypi-release-monitor-api").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 '{}' | apify call automly/pypi-release-monitor-api --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=automly/pypi-release-monitor-api", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "PyPI Release Monitor API", "description": "Monitor PyPI releases and package metadata from the public PyPI JSON API.", "version": "1.0", "x-build-id": "5cyJkWbYASu2h4GbC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~pypi-release-monitor-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-pypi-release-monitor-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/automly~pypi-release-monitor-api/runs": { "post": { "operationId": "runs-sync-automly-pypi-release-monitor-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/automly~pypi-release-monitor-api/run-sync": { "post": { "operationId": "run-sync-automly-pypi-release-monitor-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "packages" ], "properties": { "packages": { "title": "PyPI packages", "type": "string", "description": "Comma or newline separated PyPI package names to monitor, such as requests, fastapi, or numpy." }, "latestOnly": { "title": "Latest only", "type": "boolean", "description": "When enabled, return one summary record per package instead of recent version records.", "default": true }, "maxResults": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Maximum number of dataset records to return across all packages. Values above 100 are clamped.", "default": 100 }, "versionsPerPackage": { "title": "Versions per package", "minimum": 1, "type": "integer", "description": "How many recent versions to include for each package when latest only is disabled. Values above 50 are clamped.", "default": 10 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```