# Composer Repository Extractor (`datamule/composer-repository-extractor`) Actor Point at any Composer / Satis / Packagist-style PHP package repository (wpackagist, Roundcube, Packagist, private Satis) and get one structured row per package: version, license, authors, keywords, require, source/dist. - **URL**: https://apify.com/datamule/composer-repository-extractor.md - **Developed by:** [Datamule](https://apify.com/datamule) (community) - **Categories:** Developer tools - **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.35 / 1,000 packages This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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 ## Composer Repository Extractor **Point at any Composer / Satis / Packagist-style PHP package repository and get one clean, structured row per package** — version, license, authors, keywords, `require` / `require-dev`, and source/dist locations — straight from the repository's own metadata feed. No HTML scraping, no browser. The Composer repository protocol is **self-describing**: a repo's root `packages.json` advertises exactly how per-package metadata is reached, so **one actor works against every repository** — the huge public mirrors, a vendor's plugin feed, or your own private Satis / Toran / Repman / Private Packagist behind a token. ### Why this one Most Composer/Packagist tools on the market only ever hit **packagist.org central**. This actor speaks the underlying **repository protocol**, so it runs against *any* self-hosted or specialised feed the same way it runs against Packagist: - **wPackagist** (`https://wpackagist.org`) — every WordPress plugin & theme as a Composer package - **Roundcube plugins** (`https://plugins.roundcube.net`) - **Packagist** itself (`https://repo.packagist.org/packages.json`) - **Your private Satis / Toran / Repman / Private Packagist** — pass a bearer token or custom header It automatically handles **both** metadata schemes — the modern **Composer v2** `metadata-url` (`/p2//.json`, delta-encoded) and the older **v1** `providers-url` + `provider-includes` chain (content-hash resolution) — so you never have to know which one a given repo speaks. ### Input | Field | Type | Description | |---|---|---| | `repoUrl` | string (required) | Repository base URL or its `packages.json` URL. e.g. `https://wpackagist.org` | | `packages` | array | **Packages mode.** Explicit `vendor/name` list to fetch directly (works on any repo). Leave empty to enumerate. | | `vendorFilter` | string | Enumerate mode: keep only packages whose name starts with `/`. | | `packageFilter` | string | Enumerate mode: case-insensitive substring on the full `vendor/name`. | | `maxPackages` | integer | Global cap on emitted rows (default 100). Enumeration stops at the cap. | | `discoveryOnly` | boolean | **Discovery mode.** Emit one row describing the repo (protocol, templates, provider-include count) without fetching packages. | | `bearer` | string (secret) | Optional bearer token for a private repo. Never logged. | | `extraHeaders` | object | Optional extra HTTP headers (e.g. Basic auth for a gated Satis). Never logged. | The **run mode is auto-selected**: set `packages` → *packages* mode; set `discoveryOnly` → *discovery* mode; otherwise *enumerate* the repo with your filters. ### Output One flat, fully-nullable row per package: `name`, `vendor`, `packageName`, `type`, `description`, `latestVersion`, `versionCount`, `versions[]`, `license[]`, `authors[]`, `keywords[]`, `homepage`, `time`, `require`, `requireDev`, `suggest`, `provide`, `sourceType`/`sourceUrl`/`sourceReference`, `distType`/`distUrl`/`distReference`, `abandoned`, plus a lossless `_raw` copy of the latest version object and `_protocol` / `_repoUrl` provenance. #### Example ```json { "name": "monolog/monolog", "vendor": "monolog", "type": "library", "latestVersion": "3.10.0", "versionCount": 87, "license": ["MIT"], "keywords": ["log", "logging", "psr-3"], "require": { "php": ">=8.1", "psr/log": "^2.0 || ^3.0" }, "sourceUrl": "https://github.com/Seldaek/monolog.git", "distUrl": "https://api.github.com/repos/Seldaek/monolog/zipball/...", "_protocol": "v2-metadata" } ```` ### Pricing Pay-per-event: **one `package` event per package row** returned. Discovery mode emits a single row. ### Notes - Reads only public metadata over HTTPS; no login-walled scraping. - Every field is read defensively by key presence, so a repo that omits optional fields yields `null` for those columns rather than failing. - If the URL isn't a Composer repository (an HTML page, a 404), the run fails fast with a clear message instead of emitting empty rows. # Actor input Schema ## `repoUrl` (type: `string`): Base URL of a Composer / Satis / Packagist-style PHP package repository, or its packages.json URL directly. The Composer repository protocol is self-describing: the root packages.json advertises how per-package metadata is reached, so ONE actor works against any self-hosted feed — wpackagist.org (WordPress plugins/themes), plugins.roundcube.net, Packagist itself, or a private Satis / Toran / Repman / Private Packagist. Examples: https://wpackagist.org or https://repo.packagist.org/packages.json . The run MODE is chosen automatically from the other fields you set (see below). ## `packages` (type: `array`): PACKAGES MODE. An explicit list of 'vendor/name' packages to fetch directly (e.g. monolog/monolog, symfony/console). Works on every repo — for a Composer v1 repo the content hash is resolved automatically from the provider map. Leave EMPTY to ENUMERATE the repository instead. Fastest way to pull a known set of packages from any repo. ## `vendorFilter` (type: `string`): Optional vendor prefix used to narrow enumeration, e.g. 'wpackagist-plugin' or 'symfony'. Only packages whose name begins with '/' are kept. Leave empty to enumerate all vendors. ## `packageFilter` (type: `string`): Optional case-insensitive substring matched against the full 'vendor/name'. Only matching packages are kept during enumeration, e.g. 'cache' matches symfony/cache and wpackagist-plugin/wp-super-cache. Leave empty for no name filter. ## `maxPackages` (type: `integer`): A GLOBAL cap on the number of package rows to emit (each row is one package and one billable event). Enumeration stops as soon as the cap is reached, so a small value is a cheap, deterministic sample. Large public repos (wpackagist ~90k packages) can return a very large set — keep this bounded. Default 100. ## `discoveryOnly` (type: `boolean`): DISCOVERY MODE. When true, the actor resolves the root packages.json and emits a SINGLE row describing the repository itself: its protocol (v2 metadata-url / v1 providers-url / inline), the advertised metadata + provider templates, how many provider-includes it exposes, and its available-package patterns. A cheap way to inspect what any Composer repo supports before a full run. ## `bearer` (type: `string`): Optional bearer token for a private / auth-gated repository (sent as the Authorization: Bearer header). Not required for public repos. Never logged. ## `extraHeaders` (type: `object`): Optional extra HTTP headers as a JSON object, e.g. {"Authorization": "Basic ..."} for an HTTP-auth Satis, or a custom API header for Private Packagist. Not required for public repos. Header values are never logged. ## Actor input object example ```json { "repoUrl": "https://wpackagist.org", "maxPackages": 100, "discoveryOnly": 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "repoUrl": "https://wpackagist.org", "maxPackages": 100 }; // Run the Actor and wait for it to finish const run = await client.actor("datamule/composer-repository-extractor").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 = { "repoUrl": "https://wpackagist.org", "maxPackages": 100, } # Run the Actor and wait for it to finish run = client.actor("datamule/composer-repository-extractor").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 '{ "repoUrl": "https://wpackagist.org", "maxPackages": 100 }' | apify call datamule/composer-repository-extractor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=datamule/composer-repository-extractor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Composer Repository Extractor", "description": "Point at any Composer / Satis / Packagist-style PHP package repository (wpackagist, Roundcube, Packagist, private Satis) and get one structured row per package: version, license, authors, keywords, require, source/dist.", "version": "0.1", "x-build-id": "NmdBuSUMMAq0O2wgu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~composer-repository-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-composer-repository-extractor", "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/datamule~composer-repository-extractor/runs": { "post": { "operationId": "runs-sync-datamule-composer-repository-extractor", "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/datamule~composer-repository-extractor/run-sync": { "post": { "operationId": "run-sync-datamule-composer-repository-extractor", "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": [ "repoUrl" ], "properties": { "repoUrl": { "title": "Composer repository URL", "type": "string", "description": "Base URL of a Composer / Satis / Packagist-style PHP package repository, or its packages.json URL directly. The Composer repository protocol is self-describing: the root packages.json advertises how per-package metadata is reached, so ONE actor works against any self-hosted feed — wpackagist.org (WordPress plugins/themes), plugins.roundcube.net, Packagist itself, or a private Satis / Toran / Repman / Private Packagist. Examples: https://wpackagist.org or https://repo.packagist.org/packages.json . The run MODE is chosen automatically from the other fields you set (see below)." }, "packages": { "title": "Explicit package list (MODE: packages)", "type": "array", "description": "PACKAGES MODE. An explicit list of 'vendor/name' packages to fetch directly (e.g. monolog/monolog, symfony/console). Works on every repo — for a Composer v1 repo the content hash is resolved automatically from the provider map. Leave EMPTY to ENUMERATE the repository instead. Fastest way to pull a known set of packages from any repo.", "items": { "type": "string" } }, "vendorFilter": { "title": "Vendor filter (enumerate mode)", "type": "string", "description": "Optional vendor prefix used to narrow enumeration, e.g. 'wpackagist-plugin' or 'symfony'. Only packages whose name begins with '/' are kept. Leave empty to enumerate all vendors." }, "packageFilter": { "title": "Package name filter (enumerate mode)", "type": "string", "description": "Optional case-insensitive substring matched against the full 'vendor/name'. Only matching packages are kept during enumeration, e.g. 'cache' matches symfony/cache and wpackagist-plugin/wp-super-cache. Leave empty for no name filter." }, "maxPackages": { "title": "Max packages (global cap)", "minimum": 1, "type": "integer", "description": "A GLOBAL cap on the number of package rows to emit (each row is one package and one billable event). Enumeration stops as soon as the cap is reached, so a small value is a cheap, deterministic sample. Large public repos (wpackagist ~90k packages) can return a very large set — keep this bounded. Default 100.", "default": 100 }, "discoveryOnly": { "title": "Discovery mode (describe the repo only)", "type": "boolean", "description": "DISCOVERY MODE. When true, the actor resolves the root packages.json and emits a SINGLE row describing the repository itself: its protocol (v2 metadata-url / v1 providers-url / inline), the advertised metadata + provider templates, how many provider-includes it exposes, and its available-package patterns. A cheap way to inspect what any Composer repo supports before a full run.", "default": false }, "bearer": { "title": "Bearer token", "type": "string", "description": "Optional bearer token for a private / auth-gated repository (sent as the Authorization: Bearer header). Not required for public repos. Never logged." }, "extraHeaders": { "title": "Extra request headers", "type": "object", "description": "Optional extra HTTP headers as a JSON object, e.g. {\"Authorization\": \"Basic ...\"} for an HTTP-auth Satis, or a custom API header for Private Packagist. Not required for public repos. Header values are never logged." } } }, "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 } } } } } } } } } } ```