# NPM Scraper (`epctex/npm-scraper`) Actor One of the most crucial JavaScript communities is at your fingertips. Extract all the package information right away from NPM. Title, maintainers, readme, downloads per version, dependent libraries, and many other information can be retrieved directly! No limits! Get JSON, Excel, XML, and more! - **URL**: https://apify.com/epctex/npm-scraper.md - **Developed by:** [epctex](https://apify.com/epctex) (community) - **Categories:** Developer tools - **Stats:** 15 total users, 0 monthly users, 100.0% runs succeeded, 9 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing $10.00/month + usage To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors ## What's an Apify Actor? Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows. 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. - **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use). - **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`. - **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`. - **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`. - **Any other language** — 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 ## Actor - NPM Scraper ### NPM scraper Since NPM doesn't provide a good and free API, this actor should help you to retrieve data from it. The NPM data scraper supports the following features: - Search any keyword - You can search for any keyword and retrieve all the packages that you are seeking. This feature also supports special search syntax on the search such as `keyword:` - Scrape package detail - Extremely detailed and structured data for any package at your service. Get versions, names, maintainers, all the historical data, and much more. - Get packages of a user - If you are looking for all the packages of a user, that is a one-stop shop for you! ### Bugs, fixes, updates, and changelog This scraper is under active development. If you have any feature requests you can create an issue from [here](https://github.com/epctex-support/npm-scraper/issues). ### Input Parameters The input of this scraper should be JSON containing the list of pages on NPM that should be visited. Possible fields are: - `search`: (Optional) (String) Keyword that you want to search on npmjs. - `startUrls`: (Optional) (Array) List of URLs in NPM. You should only provide search, list, user detail, or package detail URLs. - `endPage`: (Optional) (Number) Final number of page that you want to scrape. The default is `Infinite`. This applies to all `search` requests and `startUrls` individually. - `maxItems`: (Optional) (Number) You can limit scraped items. This should be useful when you search through the big lists or search results. - `proxy`: (Required) (Proxy Object) Proxy configuration. - `customMapFunction`: (Optional) (String) Function that takes each object's handle as an argument and returns the object with executing the function. This solution requires the use of **Proxy servers**, either your own proxy servers or you can use [Apify Proxy](https://www.apify.com/docs/proxy). #### Tip When you want to scrape over a specific list URL, just copy and paste the link as one of the **startUrl**. If you would like to scrape only the first page of a list then put the link for the page and have the `endPage` as 1. With the last approach that is explained above you can also fetch any interval of pages. If you provide the 5th page of a list and define the `endPage` parameter as 6 then you'll have the 5th and 6th pages only. #### Compute Unit Consumption The actor is optimized to run blazing fast and scrape as many items as possible. Therefore, it forefronts all the detailed requests. If the actor doesn't block very often it'll scrape 100 listings in less than 1 minute with ~0.01-0.03 compute units. #### NPM Scraper Input example ```json { "startUrls":[ "https://www.npmjs.com/package/lodash", "https://www.npmjs.com/~ljharb", "https://www.npmjs.com/search?q=keywords:front-end&page=0&ranking=optimal", "https://www.npmjs.com/search?q=keywords:modules", "https://www.npmjs.com/search?q=axios" ], "endPage": 5, "maxItems": 100, "proxy":{ "useApifyProxy":true } } ``` ### During the Run During the run, the actor will output messages letting you know what is going on. Each message always contains a short label specifying which page from the provided list is currently specified. When items are loaded from the page, you should see a message about this event with a loaded item count and total item count for each page. If you provide incorrect input to the actor, it will immediately stop with a failure state and output an explanation of what is wrong. ### NPM Export During the run, the actor stores results into a dataset. Each item is a separate item in the dataset. You can manage the results in any language (Python, PHP, Node JS/NPM). See the FAQ or our API reference to learn more about getting results from this NPM actor. ### Scraped NPM Properties The structure of each package in NPM looks like this: #### Package Detail ```json { "url": "https://www.npmjs.com/package/lodash", "name": "lodash", "description": "Lodash modular utilities.", "maintainers": [ { "name": "mathias", "avatars": { "small": "/npm-avatar/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdmF0YXJVUkwiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8yNGUwOGE5ZWE4NGRlYjE3YWUxMjEwNzRkMGYxNzEyNT9zaXplPTUwJmRlZmF1bHQ9cmV0cm8ifQ.1nyQBg2LJRuQRWzQgT_g8Hru5FIUsz2mCZ3yqtIGbPQ", "medium": "/npm-avatar/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdmF0YXJVUkwiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8yNGUwOGE5ZWE4NGRlYjE3YWUxMjEwNzRkMGYxNzEyNT9zaXplPTEwMCZkZWZhdWx0PXJldHJvIn0.8O30NcKyPpUc911dhXJuyBnrSQx-tLyHhFYFPIj5VcQ", "large": "/npm-avatar/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdmF0YXJVUkwiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8yNGUwOGE5ZWE4NGRlYjE3YWUxMjEwNzRkMGYxNzEyNT9zaXplPTQ5NiZkZWZhdWx0PXJldHJvIn0.XJZ0JP62pAmmumlu-AeTCji3D_2wleGxXGc86Sl5f4A" } }, ], "dist-tags": { "latest": "4.17.21" }, "lastPublish": { "maintainer": "bnjmnt4n", "time": "2021-02-20T15:42:16.891Z" }, "types": { "typescript": { "package": "@types/lodash" } }, "dependents": { "dependentsCount": 171614, "dependentsTruncated": [ "feebs-cli", "fashionista", "bless-brunch" ] }, "downloads": [ { "downloads": 38796856, "label": "2022-04-12 to 2022-04-18" }, ], "author": { "name": "John-David Dalton", "avatars": { "small": "/npm-avatar/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdmF0YXJVUkwiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8yOTlhM2Q4OTFmZjE5MjBiNjljMzY0ZDA2MTAwNzA0Mz9zaXplPTUwJmRlZmF1bHQ9cmV0cm8ifQ.B9Vy-ZZRADWO6SYXG9debouY1FRb7AMhNqg8rO76fOw", "medium": "/npm-avatar/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdmF0YXJVUkwiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8yOTlhM2Q4OTFmZjE5MjBiNjljMzY0ZDA2MTAwNzA0Mz9zaXplPTEwMCZkZWZhdWx0PXJldHJvIn0.c1-LKdixh9shjLtVzpFB2qCaSFIyeMSRg89KtYrscAw", "large": "/npm-avatar/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdmF0YXJVUkwiOiJodHRwczovL3MuZ3JhdmF0YXIuY29tL2F2YXRhci8yOTlhM2Q4OTFmZjE5MjBiNjljMzY0ZDA2MTAwNzA0Mz9zaXplPTQ5NiZkZWZhdWx0PXJldHJvIn0.wTHgJF3dJNHDR2eKg8YGLK6neCgefwB7LCWcRPgQErw" } }, "homepage": "https://lodash.com/", "keywords": [ "modules", "stdlib", "util" ], "license": "MIT", "repository": "https://github.com/lodash/lodash", "versions": [ { "version": "4.17.21", "date": { "ts": 1613835736891, "rel": "2 years ago" }, "dist": { "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "shasum": "679591c564c3bffaae8454cf0b3df370c3d6911c", "tarball": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", "fileCount": 1054, "unpackedSize": 1412415, "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgMS3ZCRA9TVsSAnZWagAA8+4P/jx+SJ6Ue5oAJjz0L7gw\nLDD5YvP8aoliFq4GYkwUXfVQvOwomIPfa+U5Kao/hDfuwFQ/Bq5D5nSsl2bj\nrjJgvlKXna0SId8AgDgY2fB7zSfninuJvalY4iTWMN8DFSpG0XE2QFfoKpd3\njDmuzcNtgr79QV6DgjOVkHiP1IGNDlLTc1QEKiwo/5CdGQi1q/iCj6dViQMJ\nByuuuV2Qzi3f/FI25cG797WZar1MHhhlcnB50HiVBGp54IZOyuqdqWPduZQo\nvhONtonxPGBm3/J+uAkeUSSyL3Ud+FzLvdg8WEI9gDL0yvU4k0FcsnOONEYn\nngLaKEsw2xAnPBYW3Lf73Jnpwx6FAT3k49kgzxiNYSxEo7x4wiuNtBoDMyNw\nEKj6SZ0bUNmaJgiMfDnnDjCKjI3JrO1hho8z6CkwuvxuWLlW9wSsVayggzAI\nEhfeTeISugVHh332oDY2MI/Ysu8MnVN8fGmqeYQBBFj3aWatuA2NvVjACnX/\n54G7FtCU8TxZpm9shFRSopBx8PeI3r+icx1CT8YVFypY416PLnidHyqtME1G\neuRd1nWEz18hvVUAEHmuvHo+EPP3tITmTTUPQcZGMdBcZC+4UBmPMWX466HE\nbHw4aOnUWMa0sWfsERC5xzRZAb4lgMPEoTOnZyN4usMy7x9TzGZKZvU24HUE\nmpae\r\n=NOmG\r\n-----END PGP SIGNATURE-----\r\n", "signatures": [ { "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA", "sig": "MEUCIF3Yithbtmy1aEBNlfNWbLswAfPIyQUuNUGARD3Ex2t4AiEA6TlN2ZKJCUpS/Sf2Z6MduF1BNSvayHIpu5wAcICcKXw=" } ] } }, ], "readme": "

\nlodash v4.17.21

\n

The Lodash library exported as Node.js modules.

\n

\nInstallation

\n

Using npm:

\n
$ npm i -g npm\n$ npm i --save lodash
\n

In Node.js:

\n
// Load the full build.\nvar _ = require('lodash');\n// Load the core build.\nvar _ = require('lodash/core');\n// Load the FP build for immutable auto-curried iteratee-first data-last methods.\nvar fp = require('lodash/fp');\n\n// Load method categories.\nvar array = require('lodash/array');\nvar object = require('lodash/fp/object');\n\n// Cherry-pick methods for smaller browserify/rollup/webpack bundles.\nvar at = require('lodash/at');\nvar curryN = require('lodash/fp/curryN');
\n

See the package source for more details.

\n

Note:
\nInstall n_ for Lodash use in the Node.js < 6 REPL.

\n

\nSupport

\n

Tested in Chrome 74-75, Firefox 66-67, IE 11, Edge 18, Safari 11-12, & Node.js 8-12.
\nAutomated browser & CI test runs are available.

\n" } ``` ### Contact Please visit us through [epctex.com](https://epctex.com) to see all the products that are available for you. If you are looking for any custom integration or so, please reach out to us through the chat box in [epctex.com](https://epctex.com). In need of support? is at your service. # Actor input Schema ## `startUrls` (type: `array`): URLs to start with. It should be search, user detail or package detail URL ## `search` (type: `string`): The keyword that you can search on NPM ## `maxItems` (type: `integer`): Maximum number of listing items that you want as output. Default is all ## `endPage` (type: `integer`): The page number that you want to end with. By default there is no end page. This is applies to all search request and startUrls individually. ## `customMapFunction` (type: `string`): Function that takes each of the objects as argument and returns data that will be mapped by the function itself. ## `proxy` (type: `object`): Select proxies to be used by your crawler. ## Actor input object example ```json { "startUrls": [ "https://www.npmjs.com/package/lodash", "https://www.npmjs.com/~ljharb", "https://www.npmjs.com/search?q=keywords:front-end&page=0&ranking=optimal", "https://www.npmjs.com/search?q=keywords:modules", "https://www.npmjs.com/search?q=axios" ], "maxItems": 20, "endPage": 1, "customMapFunction": "(object) => { return {...object} }", "proxy": { "useApifyProxy": true } } ``` # 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 = { "startUrls": [ "https://www.npmjs.com/package/lodash", "https://www.npmjs.com/~ljharb", "https://www.npmjs.com/search?q=keywords:front-end&page=0&ranking=optimal", "https://www.npmjs.com/search?q=keywords:modules", "https://www.npmjs.com/search?q=axios" ], "maxItems": 20, "endPage": 1, "customMapFunction": (object) => { return {...object} }, "proxy": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("epctex/npm-scraper").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 = { "startUrls": [ "https://www.npmjs.com/package/lodash", "https://www.npmjs.com/~ljharb", "https://www.npmjs.com/search?q=keywords:front-end&page=0&ranking=optimal", "https://www.npmjs.com/search?q=keywords:modules", "https://www.npmjs.com/search?q=axios", ], "maxItems": 20, "endPage": 1, "customMapFunction": "(object) => { return {...object} }", "proxy": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("epctex/npm-scraper").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 '{ "startUrls": [ "https://www.npmjs.com/package/lodash", "https://www.npmjs.com/~ljharb", "https://www.npmjs.com/search?q=keywords:front-end&page=0&ranking=optimal", "https://www.npmjs.com/search?q=keywords:modules", "https://www.npmjs.com/search?q=axios" ], "maxItems": 20, "endPage": 1, "customMapFunction": "(object) => { return {...object} }", "proxy": { "useApifyProxy": true } }' | apify call epctex/npm-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=epctex/npm-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification Download the OpenAPI definition: https://api.apify.com/v2/actors/JGh6zXWjiHFcucORM/builds/u5cXHQKe49XT47fuo/openapi.json