{ "openapi": "3.0.1", "info": { "title": "npm + PyPI Package Release & Supply-Chain Monitor", "description": "Monitor npm and PyPI packages for new releases, dependency changes, maintainer changes, license changes, deprecations, yanked releases, artifact hashes, provenance, and download shifts. Built for dependency tracking, software supply-chain monitoring, DevOps, security, and automated alerts.", "version": "0.1", "x-build-id": "YW7wDnbTdKKiilN7b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/produkdigitalali~npm-pypi-release-supply-chain-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-produkdigitalali-npm-pypi-release-supply-chain-monitor", "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/produkdigitalali~npm-pypi-release-supply-chain-monitor/runs": { "post": { "operationId": "runs-sync-produkdigitalali-npm-pypi-release-supply-chain-monitor", "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/produkdigitalali~npm-pypi-release-supply-chain-monitor/run-sync": { "post": { "operationId": "run-sync-produkdigitalali-npm-pypi-release-supply-chain-monitor", "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", "properties": { "npmPackages": { "title": "npm packages", "maxItems": 200, "type": "array", "description": "npm package names, including scoped packages such as @types/node.", "items": { "type": "string", "minLength": 1, "maxLength": 214 }, "default": [] }, "pypiPackages": { "title": "PyPI packages", "maxItems": 200, "type": "array", "description": "PyPI project names. Names are normalized using PyPI/PEP 503 style comparison for deduplication.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [] }, "maxPackages": { "title": "Maximum packages", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard cap across npm and PyPI packages after deduplication.", "default": 100 }, "includeDependencies": { "title": "Include dependencies", "type": "boolean", "description": "Include npm dependency groups and PyPI requires_dist metadata in each snapshot.", "default": true }, "includeReleaseHistory": { "title": "Include release history", "type": "boolean", "description": "Include a bounded newest-first release history for each package.", "default": true }, "maxReleaseHistory": { "title": "Maximum release history", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum release/version entries retained in each package snapshot.", "default": 20 }, "includeDownloadStats": { "title": "Include npm download stats", "type": "boolean", "description": "Fetch public npm download counts for the selected period. PyPI's JSON API does not provide usable download counts, so PyPI records leave this field null.", "default": true }, "downloadPeriod": { "title": "npm download period", "enum": [ "last-day", "last-week", "last-month" ], "type": "string", "description": "Public npm downloads API period used for the point download count.", "default": "last-week" }, "monitorMode": { "title": "Monitoring mode", "type": "boolean", "description": "Persist normalized package state and classify changes such as NEW_VERSION, DEPENDENCY_CHANGED, MAINTAINER_CHANGED, LICENSE_CHANGED, DEPRECATED, YANKED, DOWNLOAD_SPIKE, and DOWNLOAD_DROP.", "default": false }, "emitChangesOnly": { "title": "Emit changes only", "type": "boolean", "description": "In monitoring mode, suppress package snapshots and UNCHANGED records; emit only meaningful changes and errors.", "default": false }, "baselineOnly": { "title": "Quiet first baseline", "type": "boolean", "description": "Save first-seen package state without emitting the initial NEW event.", "default": false }, "monitorKey": { "title": "Monitor key", "maxLength": 200, "type": "string", "description": "Namespace for persistent monitoring state. Reuse the same value for related scheduled runs.", "default": "default" }, "downloadChangeThresholdPercent": { "title": "Download spike/drop threshold (%)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Minimum absolute percentage change in npm downloads required to emit DOWNLOAD_SPIKE or DOWNLOAD_DROP.", "default": 50 }, "concurrency": { "title": "Package concurrency", "minimum": 1, "maximum": 40, "type": "integer", "description": "Maximum package pipelines processed concurrently.", "default": 10 }, "requestTimeoutSeconds": { "title": "Request timeout seconds", "minimum": 3, "maximum": 90, "type": "integer", "description": "Per-request timeout for npm and PyPI public APIs.", "default": 20 }, "maxRetries": { "title": "Maximum retries", "minimum": 0, "maximum": 6, "type": "integer", "description": "Retries transient connection, 429, and 5xx responses with bounded backoff.", "default": 2 } } }, "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 } } } } } } } } } }