# NPM Packages Scraper (`geodetic_marigold/npmjs-scraper`) Actor

Busca pacotes no npm por palavra-chave e devolve dados estruturados: downloads mensais e semanais, versão, número de dependentes, licença, repositório, homepage e keywords. Consumer da API pública do registry — sem browser, estável e rápido. Pronto para planilha, BI ou IA.

- **URL**: https://apify.com/geodetic\_marigold/npmjs-scraper.md
- **Developed by:** [Antonio Fernando Rincon de Mendonça](https://apify.com/geodetic_marigold) (community)
- **Categories:** Developer tools, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

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

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
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.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use 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 Packages Scraper

> Busca pacotes no **npm** por palavra-chave e devolve dados estruturados —
> downloads mensais/semanais, versão, dependentes, licença, repositório e
> keywords — via a **API pública do registry**. Sem browser, sem API key.

### Por que usar

Consome a API de busca oficial do registry (`registry.npmjs.org/-/v1/search`),
então o resultado é **estável, tipado e rápido**. Exporte em **JSON, CSV ou
Excel** (ou puxe via **API** e **MCP**) para análise de ecossistema JS/TS,
due diligence de dependências, market research de pacotes ou pipelines de IA.

### Casos de uso

- Mapear os pacotes mais baixados de um tema (ex.: `react`, `testing`, `orm`)
- Monitorar versões, dependentes e licenças de dependências
- Descobrir repositórios e homepages de um conjunto de pacotes
- Alimentar agentes de IA com dados frescos do npm

### Como rodar

1. Preencha `searchQuery` (ex.: `react`) e clique em **Start**.
2. Acompanhe o run — os pacotes aparecem no Dataset em tempo real.
3. Exporte em **JSON / CSV / Excel** ou consuma via **API** e **MCP**.
4. (Opcional) Agende execuções recorrentes no **Scheduler** da Apify.

### Input

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `searchQuery` | string | sim | O que procurar no npm. Ex.: `react`, `express`, `test framework`. |
| `maxItems` | integer | — | Máximo de pacotes a coletar (1–5000). Padrão 100. |

#### Exemplo de input

```json
{
  "searchQuery": "react",
  "maxItems": 20
}
````

### Output

Cada item no Dataset:

```json
{
  "name": "react",
  "description": "React is a JavaScript library for building user interfaces.",
  "url": "https://www.npmjs.com/package/react",
  "version": "19.2.7",
  "downloadsMonthly": 581977654,
  "downloadsWeekly": 147530499,
  "dependents": 212794,
  "license": "MIT",
  "keywords": ["react"],
  "publisher": "react-bot",
  "homepage": "https://react.dev/",
  "repository": "https://github.com/facebook/react",
  "lastPublish": "2026-06-28T05:15:41.245Z",
  "updated": "2026-06-28T05:15:41.245Z",
  "searchQuery": "react",
  "scrapedAt": "2026-06-28T00:00:00.000Z"
}
```

### Use com agentes de IA (MCP)

Este Actor é **compatível com o [Apify MCP Server](https://docs.apify.com/platform/integrations/mcp)** —
agentes de IA (Claude, ChatGPT, Cursor) descobrem o Actor pelo nome `npmjs-scraper`,
leem o `input_schema` e chamam direto. O `dataset_schema` garante output tipado e estável.

### Preço — Pay Per Event

| Evento | Preço |
|---|---|
| `package-scraped` | $0.005 por pacote retornado |

Você paga **apenas pelo resultado**: runs que não acham nada custam **zero**.

### FAQ

- **Preciso de API key ou login?** Não — a API de busca do npm é pública.
- **Em quais formatos exporto?** JSON, CSV, Excel, HTML table, ou via API/MCP.
- **Dá para agendar?** Sim — use o Scheduler da Apify para coletas recorrentes.
- **O formato do output muda entre execuções?** Não — o `dataset_schema` mantém os campos estáveis.

### Changelog

- **0.1** — primeira versão: consumer da API de busca do registry npm.

# Actor input Schema

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

O que procurar no npm. Ex.: "react", "express", "test framework", "date".

## `maxItems` (type: `integer`):

Limite superior de pacotes a coletar. Valores altos aumentam o tempo do run (a API entrega até 100 por página).

## Actor input object example

```json
{
  "searchQuery": "react",
  "maxItems": 100
}
```

# 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 = {
    "searchQuery": "react"
};

// Run the Actor and wait for it to finish
const run = await client.actor("geodetic_marigold/npmjs-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 = { "searchQuery": "react" }

# Run the Actor and wait for it to finish
run = client.actor("geodetic_marigold/npmjs-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 '{
  "searchQuery": "react"
}' |
apify call geodetic_marigold/npmjs-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=geodetic_marigold/npmjs-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "NPM Packages Scraper",
        "description": "Busca pacotes no npm por palavra-chave e devolve dados estruturados: downloads mensais e semanais, versão, número de dependentes, licença, repositório, homepage e keywords. Consumer da API pública do registry — sem browser, estável e rápido. Pronto para planilha, BI ou IA.",
        "version": "0.1",
        "x-build-id": "CAvmWzqkrrAWD5Nbp"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/geodetic_marigold~npmjs-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-geodetic_marigold-npmjs-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/geodetic_marigold~npmjs-scraper/runs": {
            "post": {
                "operationId": "runs-sync-geodetic_marigold-npmjs-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/geodetic_marigold~npmjs-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-geodetic_marigold-npmjs-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": [
                    "searchQuery"
                ],
                "properties": {
                    "searchQuery": {
                        "title": "Palavra-chave de busca",
                        "minLength": 1,
                        "maxLength": 200,
                        "type": "string",
                        "description": "O que procurar no npm. Ex.: \"react\", \"express\", \"test framework\", \"date\"."
                    },
                    "maxItems": {
                        "title": "Máximo de pacotes",
                        "minimum": 1,
                        "maximum": 5000,
                        "type": "integer",
                        "description": "Limite superior de pacotes a coletar. Valores altos aumentam o tempo do run (a API entrega até 100 por página).",
                        "default": 100
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
