# GitHub Repository Scraper (`cloud9_ai/github-scraper`) Actor Scrape GitHub repositories, users, and trending projects via REST API. Extract repo names, stars, forks, languages, descriptions, and contributor data. - **URL**: https://apify.com/cloud9\_ai/github-scraper.md - **Developed by:** [cloud9](https://apify.com/cloud9_ai) (community) - **Categories:** AI, Automation - **Stats:** 20 total users, 2 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. 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 ## GitHub Scraper Scrape GitHub repositories, users, and trending projects via the GitHub REST API. ### Features - **3 Scraping Modes:** - `searchRepos`: Search for repositories by keywords - `searchUsers`: Search for GitHub users - `trending`: Get trending repositories (created in last 7 days, sorted by stars) - **Filters:** - Programming language filter - Sort options: stars, forks, updated, best-match - Configurable max results (1-100) - **No Authentication Required:** Uses GitHub's public REST API (60 requests/hour unauthenticated) ### Input Parameters | Field | Type | Required | Description | |-------|------|----------|-------------| | `mode` | String | Yes | Scraping mode: `searchRepos`, `searchUsers`, or `trending` | | `searchQuery` | String | No | Search keywords (not used for trending mode) | | `language` | String | No | Filter by programming language (e.g., Python, JavaScript) | | `sort` | String | No | Sort by: `stars`, `forks`, `updated`, or `best-match` | | `maxResults` | Integer | No | Maximum results to scrape (1-100, default: 30) | | `proxyConfiguration` | Object | No | Proxy settings for API requests | ### Example Input #### Search Repositories ```json { "mode": "searchRepos", "searchQuery": "machine learning", "language": "Python", "sort": "stars", "maxResults": 30 } ```` #### Search Users ```json { "mode": "searchUsers", "searchQuery": "javascript developer", "maxResults": 20 } ``` #### Trending Repositories ```json { "mode": "trending", "language": "TypeScript", "maxResults": 50 } ``` ### Output Data #### Repository Output ```json { "name": "tensorflow", "fullName": "tensorflow/tensorflow", "description": "An Open Source Machine Learning Framework for Everyone", "url": "https://github.com/tensorflow/tensorflow", "stars": 185000, "forks": 74000, "language": "Python", "topics": ["machine-learning", "deep-learning", "tensorflow"], "owner": "tensorflow", "ownerUrl": "https://github.com/tensorflow", "createdAt": "2015-11-07T01:19:20Z", "updatedAt": "2024-02-14T12:34:56Z", "openIssues": 2500, "watchers": 185000, "defaultBranch": "master", "license": "Apache License 2.0", "homepage": "https://www.tensorflow.org" } ``` #### User Output ```json { "login": "torvalds", "url": "https://github.com/torvalds", "avatarUrl": "https://avatars.githubusercontent.com/u/1024025", "type": "User", "publicRepos": 6, "followers": 180000, "following": 0, "createdAt": "2011-09-03T15:26:22Z", "bio": "Creator of Linux and Git", "company": "Linux Foundation", "location": "Portland, OR", "blog": "https://torvalds-family.blogspot.com" } ``` ### Rate Limits - **Unauthenticated API:** 60 requests per hour - **Rate Limit Handling:** Automatic wait and retry if rate limit is hit - **Request Delay:** 1.5 seconds between requests to avoid hitting limits ### Technical Details - Uses GitHub REST API v3 - Built with Apify SDK 3.0 and Crawlee 3.0 - TypeScript for type safety - `gotScraping` for HTTP requests with proxy support - Multi-stage Docker build for optimized image size ### Local Development ```bash ## Install dependencies npm install ## Build TypeScript npm run build ## Run locally npm start ``` ### Deployment Deploy to Apify platform: ```bash apify push ``` ### Use Cases - Repository discovery and analysis - Trending technology tracking - Developer community research - Open source project monitoring - Programming language popularity tracking ### License MIT # Actor input Schema ## `mode` (type: `string`): Choose what to scrape: repositories, users, or trending projects ## `searchQuery` (type: `string`): Search keywords (not used for 'trending' mode) ## `language` (type: `string`): Filter by programming language (e.g., Python, JavaScript, Go). Leave empty for all languages. ## `sort` (type: `string`): How to sort the results ## `maxResults` (type: `integer`): Maximum number of results to scrape ## `proxyConfiguration` (type: `object`): Proxy settings for API requests ## Actor input object example ```json { "mode": "searchRepos", "searchQuery": "machine learning", "sort": "stars", "maxResults": 5, "proxyConfiguration": { "useApifyProxy": true } } ``` # 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 = { "maxResults": 5 }; // Run the Actor and wait for it to finish const run = await client.actor("cloud9_ai/github-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 = { "maxResults": 5 } # Run the Actor and wait for it to finish run = client.actor("cloud9_ai/github-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 '{ "maxResults": 5 }' | apify call cloud9_ai/github-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=cloud9_ai/github-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "GitHub Repository Scraper", "description": "Scrape GitHub repositories, users, and trending projects via REST API. Extract repo names, stars, forks, languages, descriptions, and contributor data.", "version": "0.1", "x-build-id": "gJi89FOMhx7Aido89" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cloud9_ai~github-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cloud9_ai-github-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/cloud9_ai~github-scraper/runs": { "post": { "operationId": "runs-sync-cloud9_ai-github-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/cloud9_ai~github-scraper/run-sync": { "post": { "operationId": "run-sync-cloud9_ai-github-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": "Scraping Mode", "enum": [ "searchRepos", "searchUsers", "trending" ], "type": "string", "description": "Choose what to scrape: repositories, users, or trending projects", "default": "searchRepos" }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Search keywords (not used for 'trending' mode)", "default": "machine learning" }, "language": { "title": "Programming Language", "type": "string", "description": "Filter by programming language (e.g., Python, JavaScript, Go). Leave empty for all languages." }, "sort": { "title": "Sort By", "enum": [ "stars", "forks", "updated", "best-match" ], "type": "string", "description": "How to sort the results", "default": "stars" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of results to scrape", "default": 30 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for API requests", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } } ```