# GitHub Repository Scraper - Stars, Forks, Issues & README (`aolmo/github-repo`) Actor

Public details of any GitHub repository by URL or owner/name: stars, forks, watchers, open issues, language, topics, license, description, homepage, dates, archived flag and README text. No token. Scheduled runs report star, fork and issue changes. $0.001 per repository.

- **URL**: https://apify.com/aolmo/github-repo.md
- **Developed by:** [Antonio del Olmo Tena](https://apify.com/aolmo) (community)
- **Categories:** Developer tools
- **Features:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.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

Get the public details of any GitHub repository from its URL or `owner/name`, without a token: stars, forks, watchers, open issues, primary language, topics, license, description, homepage, creation, update and last-push dates, archived and fork flags, repository size and the README as text. Schedule it and star, fork and issue changes are reported. Open-source monitoring, competitor and ecosystem research, developer-tool lead lists and due diligence at $0.001 per repository.

The Actor reads GitHub's public REST API (spreading the per-IP limit across rotating connections) and falls back to the public repository page when the API is unavailable. The README comes from the raw file of the default branch.

### What you get

**Repository** (one row each): `owner`, `name`, `fullName`, `url`, `description`, `homepage`, `language`, `topics`, `stars`, `forks`, `watchers`, `openIssues` (issues and pull requests), `license` (SPDX id), `isArchived`, `isFork`, `defaultBranch`, `createdAt`, `updatedAt`, `pushedAt`, `sizeKb`, `readme` (Markdown, up to 20,000 characters), `readmeExcerpt`, `source` (`api` or `html`).

**Changes** on scheduled runs: `starsChange`, `forksChange`, `openIssuesChange` (null on the first run), plus an event when the repository is archived.

Repositories that do not exist or are private return a row with an `error` field and are not charged.

### How to use it

1. Open the **Input** tab.
2. Add **Repositories**, one per line (up to 1,000 per run): `apify/crawlee` or `https://github.com/apify/crawlee`.
3. Keep **Include README** on to get the README text, or turn it off for a faster run.
4. Click **Start** and export the rows as JSON, CSV or Excel.
5. Schedule the Actor to track stars and activity over time.

### Input

```json
{
  "repos": ["apify/crawlee", "https://github.com/microsoft/playwright"],
  "includeReadme": true
}
```

### Output

```json
{
  "owner": "apify",
  "name": "crawlee",
  "fullName": "apify/crawlee",
  "url": "https://github.com/apify/crawlee",
  "description": "Crawlee—A web scraping and browser automation library for Node.js...",
  "homepage": "https://crawlee.dev",
  "language": "TypeScript",
  "topics": ["crawler", "scraper", "web-scraping", "playwright", "puppeteer"],
  "stars": 26275,
  "forks": 1733,
  "watchers": 135,
  "openIssues": 150,
  "license": "Apache-2.0",
  "isArchived": false,
  "defaultBranch": "master",
  "createdAt": "2016-04-14T10:00:00Z",
  "pushedAt": "2026-10-27T10:12:51Z",
  "readmeExcerpt": "Crawlee covers your crawling and scraping end-to-end...",
  "source": "api",
  "starsChange": null,
  "timestamp": "2026-10-27T10:00:00.000Z"
}
```

### Pricing

Pay per event: **$0.001 per repository** and **$0.0005 per repository whose stats changed** on a scheduled run. Repositories that cannot be read are free. 1,000 repositories cost $1.00.

### Limits and notes

- When the fallback page is used (`source: html`), open issues, dates, homepage and flags may be null.
- The README is the raw Markdown of `README.md` (or `readme.md`, `README.rst`, `README`) on the default branch.
- The Actor never bypasses logins, CAPTCHAs or rate limits.

### Related Actors

- **Website Contact Extractor**: contacts of the project websites.
- **Company Profile Scraper**: details of the companies behind the repositories.

# Actor input Schema

## `repos` (type: `array`):

One per line: apify/crawlee or https://github.com/apify/crawlee. Up to 1,000 per run.

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

Also fetch the README (Markdown text, up to 20,000 characters) and a plain-text excerpt.

## `product` (type: `string`):

Internal. Leave as is.

## Actor input object example

```json
{
  "repos": [
    "apify/crawlee",
    "https://github.com/microsoft/playwright"
  ],
  "includeReadme": true,
  "product": "github-repo"
}
```

# Actor output Schema

## `results` (type: `string`):

Dataset items: url, changed, events, data, timestamp and error (when the target failed).

# 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 = {
    "repos": [
        "apify/crawlee",
        "https://github.com/microsoft/playwright"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("aolmo/github-repo").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 = { "repos": [
        "apify/crawlee",
        "https://github.com/microsoft/playwright",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("aolmo/github-repo").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 '{
  "repos": [
    "apify/crawlee",
    "https://github.com/microsoft/playwright"
  ]
}' |
apify call aolmo/github-repo --silent --output-dataset

```

## MCP server setup

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

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/Z5rifC66oqzGccJkK/builds/CafXaPojuqjfr4wQx/openapi.json