# Github Repo User Scraper (`inquisitive_sarangi/github-repo-scraper`) Actor

Github Repo User Scraper is simple tool to extract users of a repo(s) like contributors, stargazers & watchers. You can also export listings to JSON/CSV or any other as format.

- **URL**: https://apify.com/inquisitive_sarangi/github-repo-scraper.md
- **Developed by:** [API Master](https://apify.com/inquisitive_sarangi) (community)
- **Categories:** Lead generation
- **Features:** Full permissions
- **Stats:** 62 total users, 0 monthly users, 100.0% runs succeeded, 4 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/actors/running/actors-in-store.md#pay-per-usage

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

## What is Github Repo scraper?

It is simple tool to extract users of a repo(s) like contributors, stargazers & watchers. You can also export listings to JSON/CSV or any other as format supported by Apify.

## Input

```json
{
    "mode": "repo",
    "maxResults": 100,                          // 0 means not limit, default is 0
    "proxy": {
        "useApifyProxy": true,
    },
    "repoUrls": [
        "https://github.com/<OWNER>/<REPO>"     // recommended to use proxies otherwise will
                                                // get rate limited as github allows 60 req/hr
                                                // for unauthenticated user
    ],
    "stargazers": false,                        // optional, default is false
    "watchers": false,                          // optional, default is false
    "maxConcurrency": 5,                        // optional, default is 5
    "maxRequestsPerMinute": 200                 // optional, default is 200
}
```

## Output

```json
[
    {
        "repo": "kubernetes/kubernetes",
        "isContributor": true,
        "username": "imui",
        "id": 128136030,
        "avatarUrl": "https://avatars.githubusercontent.com/u/1656030?v=4",
        "gravatarId": "",
        "profileUrl": "https://github.com/imui",
        "displayName": null,
        "company": null,
        "blog": "",
        "location": null,
        "hireable": null,
        "bio": null,
        "twitter": null,
        "publicReposCount": 7,
        "publicGistsCount": 0,
        "followers": 1,
        "following": 0,
        "createdAt": "2023-03-17T09:11:02Z",
        "updatedAt": "2023-10-17T13:30:41Z",
        "orgs": [],
        "email": "",
        "languages": [
            "HTML",
            "JavaScript"
        ]
    },
    ....
    ....
]
```

### Important

**NOTE**:
For unauthenticated requests, the rate limit allows for up to 60 requests per hour so it is advisable to use a proxy.

# Actor input Schema

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

Select your mode

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

Select proxies to be used by your scraper.

## `maxResults` (type: `integer`):

0 means no limit

## `repoUrls` (type: `array`):

No description

## `stargazers` (type: `boolean`):

if enabled we users who have starred repo

## `watchers` (type: `boolean`):

if enabled we users who are watching repo

## `maxConcurrency` (type: `integer`):

depends on your apify plan limits, max allowed upto 25

## `maxRequestsPerMinute` (type: `integer`):

max allowed upto 2000

## Actor input object example

```json
{
  "mode": "repo",
  "proxy": {
    "useApifyProxy": true
  },
  "maxResults": 1,
  "repoUrls": [
    "https://github.com/CUCyber/ja3transport"
  ],
  "stargazers": false,
  "watchers": false,
  "maxConcurrency": 1,
  "maxRequestsPerMinute": 200
}
```

# 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": "repo",
    "proxy": {
        "useApifyProxy": true
    },
    "maxResults": 1,
    "repoUrls": [
        "https://github.com/tech-engine/goscrapy"
    ],
    "maxConcurrency": 1,
    "maxRequestsPerMinute": 200
};

// Run the Actor and wait for it to finish
const run = await client.actor("inquisitive_sarangi/github-repo-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": "repo",
    "proxy": { "useApifyProxy": True },
    "maxResults": 1,
    "repoUrls": ["https://github.com/tech-engine/goscrapy"],
    "maxConcurrency": 1,
    "maxRequestsPerMinute": 200,
}

# Run the Actor and wait for it to finish
run = client.actor("inquisitive_sarangi/github-repo-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 '{
  "mode": "repo",
  "proxy": {
    "useApifyProxy": true
  },
  "maxResults": 1,
  "repoUrls": [
    "https://github.com/tech-engine/goscrapy"
  ],
  "maxConcurrency": 1,
  "maxRequestsPerMinute": 200
}' |
apify call inquisitive_sarangi/github-repo-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,inquisitive_sarangi/github-repo-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/ZIKk5B9KPHauLAuRE/builds/LTzhcbMz8L0wUa1QR/openapi.json
