# LuaRocks Scraper (`crawlerbros/luarocks-scraper`) Actor Scrape LuaRocks - the official Lua package repository. Search modules or fetch details for specific rocks. Extract names, descriptions, authors, versions, licenses, homepages, download counts, and labels. - **URL**: https://apify.com/crawlerbros/luarocks-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** Developer tools, Integrations - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. 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.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 ## LuaRocks Scraper Scrape [LuaRocks](https://luarocks.org) — the official package manager and repository for Lua modules. Search for rocks by keyword or fetch full details for specific modules. Extract names, descriptions, authors, versions, licenses, homepages, download counts, and labels. ### What You Can Scrape - **Module metadata** — name, description, author, version, license - **Download statistics** — total download count per module - **Links** — homepage and source repository URLs - **Labels** — community-assigned category labels - **Versions** — latest stable version string ### Input | Field | Type | Description | |-------|------|-------------| | `mode` | select | `searchRocks` (default) or `getByName` | | `searchQuery` | string | Free-text search query (e.g. `http`, `json`, `redis`) | | `rockNames` | array | For `getByName`: rock names like `["luasocket"]` or `["lunarmodules/luasocket"]` | | `maxItems` | integer | Maximum number of rocks to return (1–500, default 50) | ### Output Each record contains: | Field | Description | |-------|-------------| | `rockName` | Module name slug | | `description` | Module description or summary | | `version` | Latest stable version string | | `author` | Uploader/author username | | `license` | License identifier (e.g. MIT, Apache-2.0) | | `homepage` | Official homepage URL | | `repositoryUrl` | Source repository URL (GitHub, GitLab, etc.) | | `labels` | Community-assigned label strings | | `downloadCount` | Total download count across all versions | | `sourceUrl` | Direct LuaRocks module page URL | | `recordType` | Always `"rock"` | | `scrapedAt` | ISO 8601 timestamp of scrape | ### Sample Output ```json { "rockName": "http", "description": "HTTP library for Lua", "version": "0.4-0", "author": "daurnimator", "license": "MIT", "homepage": "https://daurnimator.github.io/lua-http/", "repositoryUrl": "https://github.com/daurnimator/lua-http", "labels": ["network", "http", "websockets"], "downloadCount": 1235113, "sourceUrl": "https://luarocks.org/modules/daurnimator/http", "recordType": "rock", "scrapedAt": "2026-05-30T12:00:00+00:00" } ```` ### Use Cases - **Lua ecosystem research** — discover available modules by category or functionality - **Dependency analysis** — find popular libraries for HTTP, JSON, databases, etc. - **Package monitoring** — track download trends and popular modules - **Open source intelligence** — find Lua modules and their maintainers ### FAQ **Do I need API keys or authentication?** No. LuaRocks is a public website with no authentication required. **How many rocks can I scrape?** Up to 500 per run. LuaRocks has thousands of modules — use `searchQuery` to narrow results. **Can I fetch a specific rock?** Yes — use `mode=getByName` with `rockNames` like `["luasocket"]` or `["daurnimator/http"]`. **What is the author/name format?** Either just the rock name (e.g. `luasocket`) or `author/name` (e.g. `luarocks/luarocks`). The author prefix ensures you get the exact module when multiple authors publish rocks with the same name. **How often is data refreshed?** Each run fetches live data from LuaRocks at the time of execution. # Actor input Schema ## `mode` (type: `string`): What to fetch: search for rocks by query, or retrieve details for specific rocks by name. ## `searchQuery` (type: `string`): Free-text query to search LuaRocks (used in searchRocks mode). Examples: 'http', 'json', 'redis', 'socket'. ## `rockNames` (type: `array`): Names of specific rocks to fetch. Use 'name' (e.g. 'luasocket') or 'author/name' (e.g. 'lunarmodules/luasocket') format. ## `maxItems` (type: `integer`): Maximum number of rocks to return. ## Actor input object example ```json { "mode": "searchRocks", "searchQuery": "http", "maxItems": 50 } ``` # Actor output Schema ## `rocks` (type: `string`): Dataset containing all scraped LuaRocks modules. # 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 = { "mode": "searchRocks", "searchQuery": "http", "maxItems": 50 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/luarocks-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 = { "mode": "searchRocks", "searchQuery": "http", "maxItems": 50, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/luarocks-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 '{ "mode": "searchRocks", "searchQuery": "http", "maxItems": 50 }' | apify call crawlerbros/luarocks-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/luarocks-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "LuaRocks Scraper", "description": "Scrape LuaRocks - the official Lua package repository. Search modules or fetch details for specific rocks. Extract names, descriptions, authors, versions, licenses, homepages, download counts, and labels.", "version": "1.0", "x-build-id": "GSMi87x1fPL0nWlo2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~luarocks-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-luarocks-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/crawlerbros~luarocks-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-luarocks-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/crawlerbros~luarocks-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-luarocks-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "searchRocks", "getByName" ], "type": "string", "description": "What to fetch: search for rocks by query, or retrieve details for specific rocks by name.", "default": "searchRocks" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Free-text query to search LuaRocks (used in searchRocks mode). Examples: 'http', 'json', 'redis', 'socket'." }, "rockNames": { "title": "Rock names (mode=getByName)", "type": "array", "description": "Names of specific rocks to fetch. Use 'name' (e.g. 'luasocket') or 'author/name' (e.g. 'lunarmodules/luasocket') format.", "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of rocks to return.", "default": 50 } } }, "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 } } } } } } } } } } ```