# Hackage Haskell Package Scraper (`crawlerbros/hackage-scraper`) Actor Scrapes Haskell package metadata from Hackage (hackage.haskell.org). Search packages by query, or fetch specific packages by name. - **URL**: https://apify.com/crawlerbros/hackage-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** Developer tools, Automation, Integrations - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 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 ## Hackage Haskell Package Scraper Scrape Haskell package metadata from **Hackage** (hackage.haskell.org) — the central package archive for the Haskell ecosystem. Extract package synopses, descriptions, authors, licenses, categories, build dependencies, and more. No API key required. ### What does it do? - **Search packages** by name or keyword — find all Haskell packages matching "parser", "aeson", "lens", etc. - **Fetch by name** — retrieve full metadata for specific known packages including version history and cabal file details ### Input | Field | Type | Description | |---|---|---| | `mode` | select | `searchPackages` or `getByName` | | `searchQuery` | string | Keyword to filter packages (for `searchPackages` mode) | | `packageNames` | array | Exact package names to fetch (for `getByName` mode) | | `maxItems` | integer | Max results (1–1000, default 50) | #### Example inputs **Search for JSON-related packages:** ```json { "mode": "searchPackages", "searchQuery": "json", "maxItems": 20 } ```` **Fetch specific packages:** ```json { "mode": "getByName", "packageNames": ["aeson", "parsec", "megaparsec", "text"], "maxItems": 10 } ``` ### Output Each record contains: | Field | Description | |---|---| | `packageName` | Hackage package name | | `version` | Latest stable version | | `synopsis` | Short one-line description | | `description` | Full package description (trimmed to 1000 chars) | | `author` | Package author(s) | | `maintainer` | Current maintainer with email | | `license` | License type (e.g. BSD-3-Clause, MIT) | | `homepage` | Project homepage URL | | `bugReports` | Issue tracker URL | | `category` | Hackage category tags | | `buildDepends` | Build dependencies (list of package names) | | `deprecated` | Whether this package is deprecated | | `hackageUrl` | Hackage package page URL | | `sourceUrl` | Same as hackageUrl | | `recordType` | Always `"package"` | | `scrapedAt` | ISO 8601 timestamp | #### Example output record ```json { "packageName": "aeson", "version": "2.2.3.0", "synopsis": "Fast JSON parsing and encoding", "description": "A JSON parsing and encoding library optimized for ease of use and high performance...", "author": "Bryan O'Sullivan", "maintainer": "Adam Bergmark ", "license": "BSD-3-Clause", "homepage": "https://github.com/haskell/aeson", "bugReports": "https://github.com/haskell/aeson/issues", "category": "Text, Web, JSON", "buildDepends": ["base", "bytestring", "containers", "text", "time"], "deprecated": false, "hackageUrl": "https://hackage.haskell.org/package/aeson", "sourceUrl": "https://hackage.haskell.org/package/aeson", "recordType": "package", "scrapedAt": "2025-01-01T00:00:00+00:00" } ``` ### FAQs **Do I need an API key?** No. Hackage provides a fully public REST API with no authentication required. **How are packages found?** The actor uses Hackage's `/packages/search.json?terms=` endpoint to find relevant packages, then fetches each package's `.cabal` file for detailed metadata. **What is a cabal file?** A `.cabal` file is the Haskell package manifest — it contains all metadata about a Haskell package including dependencies, licensing, and description. **What does `deprecated` mean?** A package marked `deprecated: true` has been superseded by another package. The actor still scrapes its metadata but flags it clearly. **Can I search by category?** The `searchQuery` field matches against package names in search results. Use queries like "parser", "web", "database", "crypto" to find packages in those domains. **How many packages are on Hackage?** Hackage hosts over 15,000 Haskell packages. The `searchPackages` mode returns the most relevant matches for your query. # Actor input Schema ## `mode` (type: `string`): Scraping mode: searchPackages (search by query) or getByName (fetch specific packages). ## `searchQuery` (type: `string`): Filter packages by name (case-insensitive substring match). Used in searchPackages mode. ## `packageNames` (type: `array`): List of exact Hackage package names to fetch. Used in getByName mode. ## `maxItems` (type: `integer`): Maximum number of packages to return. ## Actor input object example ```json { "mode": "searchPackages", "searchQuery": "parser", "maxItems": 10 } ``` # 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": "searchPackages", "searchQuery": "parser", "maxItems": 10 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/hackage-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": "searchPackages", "searchQuery": "parser", "maxItems": 10, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/hackage-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": "searchPackages", "searchQuery": "parser", "maxItems": 10 }' | apify call crawlerbros/hackage-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/hackage-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Hackage Haskell Package Scraper", "description": "Scrapes Haskell package metadata from Hackage (hackage.haskell.org). Search packages by query, or fetch specific packages by name.", "version": "0.1", "x-build-id": "6KtQUhGkbW5Z2FWvM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~hackage-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-hackage-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~hackage-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-hackage-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~hackage-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-hackage-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": [ "searchPackages", "getByName" ], "type": "string", "description": "Scraping mode: searchPackages (search by query) or getByName (fetch specific packages).", "default": "searchPackages" }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Filter packages by name (case-insensitive substring match). Used in searchPackages mode." }, "packageNames": { "title": "Package Names", "type": "array", "description": "List of exact Hackage package names to fetch. Used in getByName mode.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of packages to return.", "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 } } } } } } } } } } ```