# CPAN Module Metadata Scraper (`klondikeking/cpan-module-scraper`) Actor

Extract metadata, dependencies, and reverse-dependency counts for Perl modules from CPAN via the MetaCPAN API.

- **URL**: https://apify.com/klondikeking/cpan-module-scraper.md
- **Developed by:** [Pierrick McD0nald](https://apify.com/klondikeking) (community)
- **Categories:** Developer tools, Business
- **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

## CPAN Module Metadata Scraper — Extract Perl Package Metadata, Dependencies & Reverse Dependencies

The CPAN Module Metadata Scraper extracts structured metadata for Perl distributions from the [Comprehensive Perl Archive Network (CPAN)](https://www.cpan.org/) via the public MetaCPAN API. It is built for developers, security researchers, and DevOps teams who need to inventory Perl dependencies, track release history, or monitor the open-source Perl ecosystem.

This Actor accepts a list of CPAN distribution names (e.g., `Moose`, `JSON`, `DBI`, `Dancer2`) and returns a clean dataset with version, author, license, release date, dependency counts, reverse-dependency counts, and source links. You can also supply a search query to discover related distributions through MetaCPAN autocomplete before extraction.

### Use Cases

- **Dependency inventory** — Audit all Perl modules used across your organization and export them to a spreadsheet or SIEM.
- **Supply-chain monitoring** — Track new releases, deprecation flags, and license changes for critical CPAN distributions.
- **Competitive research** — Compare reverse-dependency counts to identify the most widely used libraries in the Perl ecosystem.
- **Security triage** — Identify deprecated modules and outdated versions that may need upgrading or replacement.
- **Dataset creation** — Build a structured corpus of Perl package metadata for research, search, or internal tooling.

### Input

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `moduleNames` | Array | Yes | CPAN distribution names to scrape, e.g., `["Moose", "JSON", "DBI"]` |
| `searchQuery` | String | No | MetaCPAN autocomplete query used to discover additional distributions |
| `maxItems` | Number | No | Maximum results to output (default: 100) |
| `includeReverseDependencies` | Boolean | No | Fetch reverse-dependency counts for each distribution (default: true) |
| `proxyConfiguration` | Object | No | Apify proxy configuration (recommended for production runs) |

### Output

The Actor outputs a dataset with one row per CPAN distribution:

```json
{
  "distribution": "Moose",
  "moduleName": "Moose",
  "version": "2.4000",
  "author": "ETHER",
  "abstract": "A postmodern object system for Perl 5",
  "license": "perl_5",
  "releaseDate": "2025-07-04T21:24:15",
  "downloadUrl": "https://cpan.metacpan.org/authors/id/E/ET/ETHER/Moose-2.4000.tar.gz",
  "homepageUrl": "http://moose.perl.org/",
  "repositoryUrl": "https://github.com/moose/Moose",
  "bugtrackerUrl": "https://rt.cpan.org/Dist/Display.html?Name=Moose",
  "dependencyCount": 42,
  "dependencyNames": "Carp, Class::Load, Data::OptList, ...",
  "reverseDependencyCount": 3122,
  "deprecated": false,
  "maturity": "released",
  "url": "https://metacpan.org/release/ETHER/Moose-2.4000"
}
````

### Pricing

Pay per event: **$0.001 per module extracted**. The Actor charges only after successfully extracting metadata, so you never pay for failed or empty requests.

### Limitations

- The Actor relies on the public MetaCPAN API. Availability and rate limits are governed by MetaCPAN.
- Distribution names are treated as distribution names, not full module paths (e.g., `Moose` works, `Moose::Role` should be mapped to its parent distribution).
- Very large dependency lists are truncated to a comma-separated string in the output.
- Reverse-dependency counts require an additional API call per distribution.

### FAQ

**Q: Do I need a CPAN or MetaCPAN account?**
A: No. The public MetaCPAN API does not require authentication.

**Q: Can I scrape all CPAN distributions at once?**
A: The Actor is designed for targeted lists or autocomplete queries. Use `maxItems` to cap output and respect API limits.

**Q: Why are some fields empty?**
A: CPAN maintainers provide metadata voluntarily. If a field such as `homepageUrl` or `repositoryUrl` is missing from the upstream release, the output will be blank.

### Changelog

- **v1.0.0** — Initial release: distribution metadata, dependency counts, reverse-dependency counts, and source links.

# Actor input Schema

## `moduleNames` (type: `array`):

List of CPAN distribution names to scrape (e.g., Moose, JSON, DBI, Dancer2). Each name is treated as a distribution.

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

Optional MetaCPAN autocomplete query. When provided, the Actor discovers distributions matching the query and merges them with the explicit module names above.

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

Maximum number of module records to output.

## `includeReverseDependencies` (type: `boolean`):

Fetch the number of distributions that depend on each scraped distribution. Adds one extra API call per result.

## `proxyConfiguration` (type: `object`):

Select a proxy to route requests through. Residential proxies are recommended for high-volume runs.

## Actor input object example

```json
{
  "moduleNames": [
    "Moose",
    "JSON",
    "DBI"
  ],
  "searchQuery": "",
  "maxItems": 100,
  "includeReverseDependencies": true,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}
```

# Actor output Schema

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

No description

## `stats` (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 = {
    "moduleNames": [
        "Moose",
        "JSON",
        "DBI"
    ],
    "searchQuery": "",
    "maxItems": 100,
    "includeReverseDependencies": true,
    "proxyConfiguration": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("klondikeking/cpan-module-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 = {
    "moduleNames": [
        "Moose",
        "JSON",
        "DBI",
    ],
    "searchQuery": "",
    "maxItems": 100,
    "includeReverseDependencies": True,
    "proxyConfiguration": { "useApifyProxy": True },
}

# Run the Actor and wait for it to finish
run = client.actor("klondikeking/cpan-module-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 '{
  "moduleNames": [
    "Moose",
    "JSON",
    "DBI"
  ],
  "searchQuery": "",
  "maxItems": 100,
  "includeReverseDependencies": true,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}' |
apify call klondikeking/cpan-module-scraper --silent --output-dataset

```

## MCP server setup

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

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "CPAN Module Metadata Scraper",
        "description": "Extract metadata, dependencies, and reverse-dependency counts for Perl modules from CPAN via the MetaCPAN API.",
        "version": "1.0",
        "x-build-id": "t9MDg8T2JIyOV2qLY"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/klondikeking~cpan-module-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-klondikeking-cpan-module-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/klondikeking~cpan-module-scraper/runs": {
            "post": {
                "operationId": "runs-sync-klondikeking-cpan-module-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/klondikeking~cpan-module-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-klondikeking-cpan-module-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": [
                    "moduleNames"
                ],
                "properties": {
                    "moduleNames": {
                        "title": "Module / Distribution Names",
                        "minItems": 1,
                        "type": "array",
                        "description": "List of CPAN distribution names to scrape (e.g., Moose, JSON, DBI, Dancer2). Each name is treated as a distribution.",
                        "items": {
                            "type": "string"
                        },
                        "default": [
                            "Moose",
                            "JSON",
                            "DBI"
                        ]
                    },
                    "searchQuery": {
                        "title": "Search Query",
                        "type": "string",
                        "description": "Optional MetaCPAN autocomplete query. When provided, the Actor discovers distributions matching the query and merges them with the explicit module names above.",
                        "default": ""
                    },
                    "maxItems": {
                        "title": "Maximum Results",
                        "type": "integer",
                        "description": "Maximum number of module records to output.",
                        "default": 100
                    },
                    "includeReverseDependencies": {
                        "title": "Include Reverse Dependency Counts",
                        "type": "boolean",
                        "description": "Fetch the number of distributions that depend on each scraped distribution. Adds one extra API call per result.",
                        "default": true
                    },
                    "proxyConfiguration": {
                        "title": "Proxy Configuration",
                        "type": "object",
                        "description": "Select a proxy to route requests through. Residential proxies are recommended for high-volume runs.",
                        "default": {
                            "useApifyProxy": true
                        }
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
