# NPM Package Metadata Scraper — Search & Inspect Packages (`alleserojje/npm-package-scraper`) Actor

Search npm and export clean package metadata — version, license, author, maintainers, repository, keywords, weekly downloads, publish dates, optional deps/version history. No API key. Pay per package.

- **URL**: https://apify.com/alleserojje/npm-package-scraper.md
- **Developed by:** [Pedro Resende](https://apify.com/alleserojje) (community)
- **Categories:** Developer tools, AI, Agents
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.00 / 1,000 package returneds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## 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

## NPM Package Metadata Scraper

Search the npm registry and export clean, structured package metadata — no API key, no setup. Built for supply-chain security audits, dependency analysis, and agent/dev tooling.

**Pay per package** — you're charged once per package row returned to the dataset.

### What it returns (one row per package)

| Field | Description |
|---|---|
| `name` | Exact npm package name |
| `description` | Package description |
| `latestVersion` | Version tagged `latest` |
| `license` | SPDX license identifier |
| `author` | Package author |
| `maintainers` | Maintainer usernames |
| `repository` | Source repository URL |
| `homepage` | Project homepage |
| `keywords` | Package keywords |
| `weeklyDownloads` | Downloads in the last 7 days |
| `lastPublishDate` / `createdDate` / `modifiedDate` | ISO timestamps |
| `totalVersions` | Number of published versions |
| `dependencies` / `devDependencies` | Latest-version dependency maps (optional) |
| `versions` | Full version-number list (optional) |

### Input

| Field | Type | Description |
|---|---|---|
| `packageName` | string | Inspect one exact package (e.g. `react`, `lodash`, `express`) |
| `searchQuery` | string | Full-text registry search (used when `packageName` is empty) |
| `topN` | int | Results to return when searching (1–100, default 20) |
| `includeDependencies` | bool | Attach latest deps + devDeps |
| `includeVersions` | bool | Attach full version history |

### Run via API

```bash
## inspect a single package
curl -X POST "https://api.apify.com/v2/acts/alleserojje~npm-package-scraper/runs?token=YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"packageName":"react","includeDependencies":true}'

## search
curl -X POST "https://api.apify.com/v2/acts/alleserojje~npm-package-scraper/runs?token=YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"searchQuery":"web scraping","topN":10}'
```

### Data sources

- npm registry: `https://registry.npmjs.org` (official, no key)
- npm downloads: `https://api.npmjs.org/downloads` (official, no key)

# Actor input Schema

## `packageName` (type: `string`):

A single exact npm package name to inspect (e.g. react, lodash, express). Takes precedence over Search query.

## `searchQuery` (type: `string`):

Full-text search across the npm registry (used when Package name is empty).

## `topN` (type: `integer`):

How many packages to return when searching (1–100, default 20).

## `includeDependencies` (type: `boolean`):

Attach the latest version's dependencies and devDependencies to each package.

## `includeVersions` (type: `boolean`):

Attach the full list of published version numbers to each package.

## `proxy` (type: `object`):

Optional — datacenter proxy available for large jobs.

## Actor input object example

```json
{
  "topN": 20,
  "includeDependencies": false,
  "includeVersions": false,
  "proxy": {
    "useApifyProxy": false
  }
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "packageName": "",
    "searchQuery": ""
};

// Run the Actor and wait for it to finish
const run = await client.actor("alleserojje/npm-package-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "packageName": "",
    "searchQuery": "",
}

# Run the Actor and wait for it to finish
run = client.actor("alleserojje/npm-package-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "packageName": "",
  "searchQuery": ""
}' |
apify call alleserojje/npm-package-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,alleserojje/npm-package-scraper"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/yN4tCAQbU3BfmqbEM/builds/KI5Gzuw200gP6cj8Z/openapi.json
