{ "openapi": "3.0.1", "info": { "title": "npm Scraper: Package Data, Versions, Downloads & Search", "description": "Export npm package metadata, full version history with publish dates and deprecations, daily download series and registry search results. Official npm APIs, scoped packages supported, no login.", "version": "0.0", "x-build-id": "UxZfYUOg5aAyzyEeK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winterlock~npm-package-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winterlock-npm-package-scraper", "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/winterlock~npm-package-scraper/runs": { "post": { "operationId": "runs-sync-winterlock-npm-package-scraper", "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/winterlock~npm-package-scraper/run-sync": { "post": { "operationId": "run-sync-winterlock-npm-package-scraper", "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": [ "mode" ], "properties": { "mode": { "title": "What to scrape", "enum": [ "packageDetails", "versions", "downloads", "search" ], "type": "string", "description": "Package metadata, every published version, a daily download series, or a registry search.", "default": "packageDetails" }, "packages": { "title": "Packages", "type": "array", "description": "Package names (express, @apify/consts) or npmjs.com links. Scoped names are encoded for you.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "For Registry search. npm search qualifiers work too, for example: web scraping keywords:crawler", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max results per search query", "minimum": 1, "maximum": 5000, "type": "integer", "description": "For Search. How many packages to return per query. npm serves up to 250 per request.", "default": 50 }, "includeDownloads": { "title": "Include download counts in Package details", "type": "boolean", "description": "Adds one request per package to fetch its download total.", "default": true }, "includePublishDates": { "title": "Include publish dates and version count", "type": "boolean", "description": "Adds createdAt, modifiedAt and versionCount. This downloads the full package document, which is close to a megabyte for popular packages, so it is off by default.", "default": false }, "maxVersionsPerPackage": { "title": "Max versions per package", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Version history mode only.", "default": 100 }, "newestVersionsFirst": { "title": "Newest versions first", "type": "boolean", "description": "For Versions. On, the newest versions come first and the cap keeps the most recent ones. Off, the history starts from the first release.", "default": true }, "downloadsPeriod": { "title": "Download period", "enum": [ "last-day", "last-week", "last-month", "last-year" ], "type": "string", "description": "Used by Daily downloads, and by Package details when download counts are on.", "default": "last-month" }, "downloadsStart": { "title": "Custom start date", "type": "string", "description": "YYYY-MM-DD. Overrides the period above. npm serves at most 18 months of history per request." }, "downloadsEnd": { "title": "Custom end date", "type": "string", "description": "YYYY-MM-DD. Required if a start date is given." }, "maxItems": { "title": "Max items in total", "minimum": 1, "type": "integer", "description": "Stop the run after saving this many items. Leave empty for no limit." }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many requests run at once. The registry copes well with four; raise it for large package lists.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for most runs. The npm registry is generous with anonymous traffic.", "default": { "useApifyProxy": false } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }