# Terraform Registry Scraper - Module Metadata & Analytics (`klondikeking/terraform-registry-scraper`) Actor Extract Terraform Registry module metadata, provider info, download analytics, source repositories, and detailed configuration (inputs, outputs, dependencies) using the official Terraform Registry API. - **URL**: https://apify.com/klondikeking/terraform-registry-scraper.md - **Developed by:** [Pierrick McD0nald](https://apify.com/klondikeking) (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 ## Terraform Registry Scraper - Module Metadata & Analytics Extract Terraform Registry module metadata, provider information, download analytics, source repositories, and detailed configuration data using the official Terraform Registry API. No authentication required. Fast, reliable, and developer-friendly. ### Use Cases - **Infrastructure Audit** — Discover and catalog all Terraform modules used across your organization, including versions, providers, and source repositories. - **Module Comparison** — Compare modules by downloads, provider coverage, input/output variables, and maintenance activity to select the best option for your stack. - **Compliance & Governance** — Track verified vs community modules, deprecation status, and dependency trees to ensure safe infrastructure-as-code practices. - **Market Research** — Analyze the most popular Terraform modules, providers, and namespaces to understand trends in cloud infrastructure tooling. - **Documentation Generation** — Extract module READMEs, input variables, and output definitions to auto-generate internal documentation or onboarding guides. ### Input | Field | Type | Required | Description | |-------|------|----------|-------------| | `searchQuery` | String | No | Keyword to search modules by name or description (e.g., vpc, kubernetes, database) | | `maxItems` | Integer | No | Maximum modules to extract, 1-1000 (default: 100) | | `provider` | String | No | Filter by cloud provider: aws, azure, gcp, kubernetes, etc. (default: all) | | `sortBy` | String | No | Sort by downloads, published_at, or name (default: downloads) | | `includeDetails` | Boolean | No | Fetch detailed metadata per module: inputs, outputs, dependencies, README length (default: false) | | `proxyConfiguration` | Object | No | Proxy settings (Apify proxy enabled by default) | ### Output The Actor outputs a dataset with the following fields: ```json { "id": "terraform-aws-modules/vpc/aws/6.6.1", "namespace": "terraform-aws-modules", "name": "vpc", "version": "6.6.1", "provider": "aws", "providerLogoUrl": "/images/providers/aws.png", "description": "Terraform module to create AWS VPC resources", "source": "https://github.com/terraform-aws-modules/terraform-aws-vpc", "tag": "v6.6.1", "publishedAt": "2026-04-02T20:22:11.071125Z", "downloads": 192036488, "verified": false, "owner": "antonbabenko", "readmeLength": 15420, "inputsCount": 42, "outputsCount": 18, "dependenciesCount": 0, "resourcesCount": 15, "versionsCount": 240, "deprecationMessage": null, "examplesCount": 3, "submodulesCount": 2 } ```` When `includeDetails` is disabled, the detailed fields (readmeLength, inputsCount, outputsCount, etc.) will be null. ### Pricing Pay per event: $0.001 per module extracted. ### Limitations - The Terraform Registry API returns 15 results per page. Large extractions may take longer due to pagination. - Detailed metadata fetching (`includeDetails`) requires one additional API call per module and increases run time. - Provider filtering is performed client-side after fetching search results. - The API does not support sorting by the Registry directly; sorting is performed client-side. ### FAQ **Q: Can I extract all modules without a search query?** A: Yes, leave the search query empty to retrieve the most popular modules across the Registry. Results are sorted by downloads by default. **Q: Does this include Terraform providers?** A: This Actor focuses on modules. Provider data is not included in the current version. **Q: How do I get the most popular AWS modules?** A: Set `searchQuery` to empty, `provider` to `aws`, and `sortBy` to `downloads`. **Q: Is authentication required?** A: No. The Terraform Registry API is public and does not require authentication. ### Changelog - **v1.0.0** — Initial release. Module search, provider filtering, sorting, and optional detailed metadata extraction. ### Support Open an issue on this Actor's Apify page for questions, bug reports, or feature requests. # Actor input Schema ## `searchQuery` (type: `string`): Keyword to search Terraform Registry modules by name or description (e.g., vpc, kubernetes, database, lambda) ## `maxItems` (type: `integer`): Maximum number of modules to extract (1-1000) ## `provider` (type: `string`): Filter results by cloud provider (e.g., aws, azure, gcp, kubernetes). Leave empty to include all providers. ## `sortBy` (type: `string`): Sort order for results ## `includeDetails` (type: `boolean`): Fetch detailed metadata for each module including inputs, outputs, dependencies, README length, and version count. Slower but more comprehensive. ## `proxyConfiguration` (type: `object`): Configure proxy settings for the scraper ## Actor input object example ```json { "searchQuery": "vpc", "maxItems": 10, "provider": "", "sortBy": "downloads", "includeDetails": false, "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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "searchQuery": "vpc", "maxItems": 10, "provider": "", "sortBy": "downloads", "includeDetails": false, "proxyConfiguration": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("klondikeking/terraform-registry-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 = { "searchQuery": "vpc", "maxItems": 10, "provider": "", "sortBy": "downloads", "includeDetails": False, "proxyConfiguration": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("klondikeking/terraform-registry-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": "vpc", "maxItems": 10, "provider": "", "sortBy": "downloads", "includeDetails": false, "proxyConfiguration": { "useApifyProxy": true } }' | apify call klondikeking/terraform-registry-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=klondikeking/terraform-registry-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Terraform Registry Scraper - Module Metadata & Analytics", "description": "Extract Terraform Registry module metadata, provider info, download analytics, source repositories, and detailed configuration (inputs, outputs, dependencies) using the official Terraform Registry API.", "version": "1.0", "x-build-id": "jFMljPePisLDL9Ygp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/klondikeking~terraform-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-klondikeking-terraform-registry-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~terraform-registry-scraper/runs": { "post": { "operationId": "runs-sync-klondikeking-terraform-registry-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~terraform-registry-scraper/run-sync": { "post": { "operationId": "run-sync-klondikeking-terraform-registry-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", "properties": { "searchQuery": { "title": "Search Query", "type": "string", "description": "Keyword to search Terraform Registry modules by name or description (e.g., vpc, kubernetes, database, lambda)", "default": "" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of modules to extract (1-1000)", "default": 100 }, "provider": { "title": "Provider Filter", "type": "string", "description": "Filter results by cloud provider (e.g., aws, azure, gcp, kubernetes). Leave empty to include all providers.", "default": "" }, "sortBy": { "title": "Sort By", "enum": [ "downloads", "published_at", "name" ], "type": "string", "description": "Sort order for results", "default": "downloads" }, "includeDetails": { "title": "Include Detailed Metadata", "type": "boolean", "description": "Fetch detailed metadata for each module including inputs, outputs, dependencies, README length, and version count. Slower but more comprehensive.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Configure proxy settings for the scraper" } } }, "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 } } } } } } } } } } ```