{ "openapi": "3.0.1", "info": { "title": "npm Registry Scraper", "description": "[💰 $2.5 / 1K] Search the public npm registry or look up exact packages, and extract package metadata, version history, maintainers, repository and homepage links, dependencies, and download statistics (day/week/month).", "version": "1.0", "x-build-id": "p8POaobsMf54J17v1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~npm-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-npm-registry-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/solidcode~npm-registry-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-npm-registry-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/solidcode~npm-registry-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-npm-registry-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", "properties": { "searchQuery": { "title": "Search query", "type": "string", "description": "Free-text search across npm packages — matched against names, descriptions, and keywords. Example: 'react', 'csv parser', or 'date library'. Advanced users can use npm search qualifiers like 'keywords:cli', 'author:sindresorhus', or 'is:unstable'. Leave empty if you only want to look up exact packages by name below." }, "packageNames": { "title": "Exact package names", "type": "array", "description": "Fetch specific packages directly instead of searching. Enter exact npm package names, including scoped packages like '@types/node' or '@angular/core'. When provided, the search query and search filters above are ignored.", "items": { "type": "string" } }, "keywords": { "title": "Keyword tags", "type": "array", "description": "Only include packages tagged with at least one of these npm keywords. Example: 'cli', 'typescript', 'testing'. Leave empty to ignore. Applies to search mode only.", "items": { "type": "string" } }, "licenses": { "title": "Licenses", "type": "array", "description": "Only include packages published under at least one of these licenses. Enter SPDX license identifiers like 'MIT', 'Apache-2.0', or 'ISC'. Leave empty to include any license. A rare license combined with a broad search may take a little longer, since few packages match — pair it with a specific search term to keep runs fast.", "items": { "type": "string" } }, "minDownloadsLastWeek": { "title": "Minimum weekly downloads", "minimum": 0, "type": "integer", "description": "Only include packages with at least this many downloads in the last week. Useful for filtering out abandoned or rarely used packages. Leave empty for no minimum. A very high minimum combined with a broad search may take a little longer, since few packages match — pair it with a specific search term to keep runs fast." }, "sortBy": { "title": "Sort results by", "enum": [ "relevance", "downloads" ], "type": "string", "description": "How to order search results. 'Best match' keeps npm's own search relevance ranking (the default). 'Most downloaded' re-orders the results you fetch with the highest weekly download counts first." }, "includeVersions": { "title": "Include full version history", "type": "boolean", "description": "Add the complete, time-ordered list of every published version (with release dates) to each package. This can make a single package's output much larger — popular packages have hundreds of versions.", "default": false }, "includeMaintainers": { "title": "Include maintainers", "type": "boolean", "description": "Add the list of package maintainers (name and email) to each result.", "default": true }, "includeDownloads": { "title": "Include download statistics", "type": "boolean", "description": "Add download counts (last day, last week, and last month) to each package.", "default": true }, "includeDependencies": { "title": "Include dependencies", "type": "boolean", "description": "Add the latest version's dependency lists (runtime, dev, and peer dependencies) to each package.", "default": false }, "maxResults": { "title": "Maximum packages", "minimum": 0, "maximum": 10000, "type": "integer", "description": "The most packages to return for a search. Set to 0 to fetch every match — a safety cap of 10,000 is then applied so very broad searches don't run indefinitely. Ignored when fetching exact package names.", "default": 50 } } }, "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 } } } } } } } } } }