# GitHub Repos Scraper (`gio21/github-repos-scraper`) Actor

Search and scrape GitHub repositories. Extract stars, forks, language, license, topics, and more from the GitHub public API.

- **URL**: https://apify.com/gio21/github-repos-scraper.md
- **Developed by:** [Gio](https://apify.com/gio21) (community)
- **Categories:** Developer tools
- **Features:** Limited permissions
- **Stats:** 4 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$5.00 / 1,000 repository scrapeds

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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## GitHub Repos Scraper

Search and scrape GitHub repositories using the public GitHub API. Extract stars, forks, language, license, topics, and more.

### Features

- Search repos by keyword, language, topic, or any GitHub search qualifier
- Sort by stars, forks, or recently updated
- Optional README extraction for each repo
- Fast and lightweight — uses GitHub REST API (no browser needed)
- Pay-per-event pricing (per repo scraped)

### Input

| Field | Type | Default | Description |
|-------|------|---------|-------------|
| query | string | web scraping | GitHub search query |
| sort | string | stars | Sort by: stars, forks, updated, best-match |
| order | string | desc | Sort order: desc, asc |
| maxItems | integer | 30 | Max repos to scrape (1-1000) |
| includeReadme | boolean | false | Fetch README content for each repo |
| proxy | object | Apify proxy | Proxy configuration |

### Output

Each repo includes: `id`, `name`, `fullName`, `owner`, `url`, `description`, `language`, `stars`, `forks`, `watchers`, `openIssues`, `license`, `topics`, `isArchived`, `isFork`, `defaultBranch`, `size`, `homepage`, `createdAt`, `updatedAt`, `pushedAt`, `scrapedAt`, and optionally `readme`.

### Cost

This actor uses pay-per-event pricing. You are charged per repository scraped. Free users are limited to 15 repos per run.

# Actor input Schema

## `query` (type: `string`):

GitHub search query (e.g. 'machine learning', 'language:python stars:>1000', 'topic:react').

## `sort` (type: `string`):

How to sort results.

## `order` (type: `string`):

Sort order.

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

Maximum number of repositories to scrape (GitHub API returns up to 1000 results per query).

## `includeReadme` (type: `boolean`):

Fetch the README content for each repository (slower, additional API calls).

## `proxy` (type: `object`):

Proxy settings. Recommended to use Apify proxy.

## Actor input object example

```json
{
  "query": "web scraping",
  "sort": "stars",
  "order": "desc",
  "maxItems": 30,
  "includeReadme": false,
  "proxy": {
    "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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "query": "web scraping",
    "sort": "stars",
    "order": "desc",
    "maxItems": 30,
    "includeReadme": false,
    "proxy": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("gio21/github-repos-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 = {
    "query": "web scraping",
    "sort": "stars",
    "order": "desc",
    "maxItems": 30,
    "includeReadme": False,
    "proxy": { "useApifyProxy": True },
}

# Run the Actor and wait for it to finish
run = client.actor("gio21/github-repos-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "query": "web scraping",
  "sort": "stars",
  "order": "desc",
  "maxItems": 30,
  "includeReadme": false,
  "proxy": {
    "useApifyProxy": true
  }
}' |
apify call gio21/github-repos-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,gio21/github-repos-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/PF5Gjx6dSzVEswZ9Y/builds/Tee1StaQ828fQe6PX/openapi.json