# Ansible Galaxy Scraper (`crawlerbros/ansible-galaxy-scraper`) Actor

Scrape Ansible Galaxy - search collections (v3 API) and roles (v1 API), or fetch specific collections by namespace.name slug. Returns download counts, tags, descriptions, license, and repository links.

- **URL**: https://apify.com/crawlerbros/ansible-galaxy-scraper.md
- **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community)
- **Categories:** Automation, Developer tools
- **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

## Ansible Galaxy Scraper

Scrape [Ansible Galaxy](https://galaxy.ansible.com) — search collections (v3 API) and roles (v1 API), or fetch specific collections by `namespace.name` slug. No authentication or proxies required.

### What it does

- **Search collections** by keyword using the Galaxy v3 API, sorted by download count
- **Search roles** by keyword using the Galaxy v1 legacy roles API
- **Fetch specific collections** by `namespace.name` slug with full version metadata
- Returns download counts, tags, descriptions, licenses, repository URLs, and canonical Galaxy links

### Input

| Field | Type | Description | Default |
|-------|------|-------------|---------|
| `mode` | string | `searchCollections`, `searchRoles`, or `getCollectionDetail` | `searchCollections` |
| `searchQuery` | string | Keyword to search for | `nginx` |
| `namespace` | string | Filter by namespace/author | — |
| `collectionSlugs` | string[] | Collection slugs `namespace.name` (mode=getCollectionDetail) | `[]` |
| `maxItems` | integer | Max records to return (1–500) | `50` |

#### Example: search collections
```json
{
  "mode": "searchCollections",
  "searchQuery": "nginx",
  "maxItems": 20
}
````

#### Example: search roles

```json
{
  "mode": "searchRoles",
  "searchQuery": "docker",
  "namespace": "geerlingguy",
  "maxItems": 10
}
```

#### Example: get specific collections

```json
{
  "mode": "getCollectionDetail",
  "collectionSlugs": ["community.general", "nginxinc.nginx_core"],
  "maxItems": 10
}
```

### Output

#### Collection record fields

| Field | Type | Description |
|-------|------|-------------|
| `namespace` | string | Collection namespace |
| `collectionName` | string | Collection name |
| `version` | string | Latest version |
| `description` | string | Description |
| `downloadCount` | integer | Total downloads |
| `stars` | integer | Community score (when available) |
| `tags` | string\[] | Tags |
| `license` | string\[] | License identifiers |
| `issuesUrl` | string | Issue tracker URL |
| `repositoryUrl` | string | Source repository URL |
| `documentationUrl` | string | Documentation URL |
| `homepageUrl` | string | Homepage URL |
| `sourceUrl` | string | `https://galaxy.ansible.com/{namespace}/{name}` |
| `recordType` | string | Always `"collection"` |
| `scrapedAt` | string | ISO 8601 timestamp |

#### Role record fields

| Field | Type | Description |
|-------|------|-------------|
| `roleId` | integer | Galaxy role ID |
| `namespace` | string | Role namespace |
| `roleName` | string | Role name |
| `description` | string | Description |
| `githubUser` | string | GitHub username |
| `githubRepo` | string | GitHub repository name |
| `downloadCount` | integer | Total downloads |
| `tags` | string\[] | Role tags |
| `latestVersion` | string | Latest published version |
| `sourceUrl` | string | `https://galaxy.ansible.com/{namespace}/{roleName}` |
| `recordType` | string | Always `"role"` |
| `scrapedAt` | string | ISO 8601 timestamp |

#### Sample collection output

```json
{
  "namespace": "nginxinc",
  "collectionName": "nginx_core",
  "version": "0.8.0",
  "description": "Install and configure NGINX and NGINX App Protect using Ansible",
  "downloadCount": 704974,
  "tags": ["nginx", "server", "web", "reverse_proxy", "load_balancer"],
  "license": [],
  "repositoryUrl": "https://github.com/nginxinc/ansible-collection-nginx",
  "issuesUrl": "https://github.com/nginxinc/ansible-collection-nginx/issues",
  "sourceUrl": "https://galaxy.ansible.com/nginxinc/nginx_core",
  "recordType": "collection",
  "scrapedAt": "2026-05-30T10:00:00+00:00"
}
```

#### Sample role output

```json
{
  "roleId": 10923,
  "namespace": "geerlingguy",
  "roleName": "docker",
  "description": "Docker for Linux.",
  "githubUser": "geerlingguy",
  "githubRepo": "ansible-role-docker",
  "downloadCount": 27701830,
  "tags": ["web", "system", "containers", "docker"],
  "latestVersion": "8.0.0",
  "sourceUrl": "https://galaxy.ansible.com/geerlingguy/docker",
  "recordType": "role",
  "scrapedAt": "2026-05-30T10:00:00+00:00"
}
```

### FAQs

**Q: Does this require an API key or proxy?**
No. Ansible Galaxy provides a fully open public API.

**Q: What is the difference between collections and roles?**
Collections (v3 API) are the modern format introduced in Ansible 2.9+. Roles (v1 API) are the legacy format. Both are supported.

**Q: How does search work for collections?**
The scraper uses the Galaxy v3 plugin/ansible/search/collection-versions API with `is_highest=true` so only the latest version of each collection is returned.

**Q: How does search work for roles?**
The scraper uses the Galaxy v1 /api/v1/roles/ endpoint with keyword filtering.

**Q: What is `getCollectionDetail` mode?**
It fetches a specific collection by its `namespace.name` slug, enriching the record with full version metadata including repository, documentation, and issues URLs.

**Q: Why is `license` sometimes an empty list?**
Many collections on Ansible Galaxy do not specify a license in their metadata. The field is omitted when empty.

# Actor input Schema

## `mode` (type: `string`):

What to scrape: collections (v3 API), roles (v1 API), or a specific collection by namespace.name.

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

Keyword to search for in collection or role names and descriptions.

## `namespace` (type: `string`):

Filter results to a specific namespace or author (e.g. community, geerlingguy).

## `collectionSlugs` (type: `array`):

Exact collection slugs in format 'namespace.name' (e.g. community.general, nginxinc.nginx\_core).

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

Maximum number of records to return.

## Actor input object example

```json
{
  "mode": "searchCollections",
  "searchQuery": "nginx",
  "collectionSlugs": [],
  "maxItems": 10
}
```

# Actor output Schema

## `items` (type: `string`):

Dataset containing all scraped Ansible Galaxy collections and roles.

# 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 = {
    "mode": "searchCollections",
    "searchQuery": "nginx",
    "namespace": "",
    "collectionSlugs": [],
    "maxItems": 10
};

// Run the Actor and wait for it to finish
const run = await client.actor("crawlerbros/ansible-galaxy-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 = {
    "mode": "searchCollections",
    "searchQuery": "nginx",
    "namespace": "",
    "collectionSlugs": [],
    "maxItems": 10,
}

# Run the Actor and wait for it to finish
run = client.actor("crawlerbros/ansible-galaxy-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": "searchCollections",
  "searchQuery": "nginx",
  "namespace": "",
  "collectionSlugs": [],
  "maxItems": 10
}' |
apify call crawlerbros/ansible-galaxy-scraper --silent --output-dataset

```

## MCP server setup

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

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Ansible Galaxy Scraper",
        "description": "Scrape Ansible Galaxy - search collections (v3 API) and roles (v1 API), or fetch specific collections by namespace.name slug. Returns download counts, tags, descriptions, license, and repository links.",
        "version": "1.0",
        "x-build-id": "KMtq63g9jiBTHkvxu"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/crawlerbros~ansible-galaxy-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-crawlerbros-ansible-galaxy-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~ansible-galaxy-scraper/runs": {
            "post": {
                "operationId": "runs-sync-crawlerbros-ansible-galaxy-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~ansible-galaxy-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-crawlerbros-ansible-galaxy-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": [
                            "searchCollections",
                            "searchRoles",
                            "getCollectionDetail"
                        ],
                        "type": "string",
                        "description": "What to scrape: collections (v3 API), roles (v1 API), or a specific collection by namespace.name.",
                        "default": "searchCollections"
                    },
                    "searchQuery": {
                        "title": "Search query",
                        "type": "string",
                        "description": "Keyword to search for in collection or role names and descriptions."
                    },
                    "namespace": {
                        "title": "Namespace / author filter",
                        "type": "string",
                        "description": "Filter results to a specific namespace or author (e.g. community, geerlingguy)."
                    },
                    "collectionSlugs": {
                        "title": "Collection slugs (mode=getCollectionDetail)",
                        "type": "array",
                        "description": "Exact collection slugs in format 'namespace.name' (e.g. community.general, nginxinc.nginx_core).",
                        "items": {
                            "type": "string"
                        }
                    },
                    "maxItems": {
                        "title": "Max items",
                        "minimum": 1,
                        "maximum": 500,
                        "type": "integer",
                        "description": "Maximum number of records to return.",
                        "default": 10
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```