# GitHub Push Event Scraper (`krab/github-push-event-scraper`) Actor

Extracts GitHub push events with your specified date range. Scrapes commit metadata, including author info (name, email), commit messages, and URLs for users, commits, and repos. Ideal for monitoring repository activity or tracking user contributions.

- **URL**: https://apify.com/krab/github-push-event-scraper.md
- **Developed by:** [Andrew K](https://apify.com/krab) (community)
- **Categories:** Developer tools, Integrations, Agents
- **Stats:** 4 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$0.45 / 1,000 events

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 Push Events Scraper

Extracts detailed GitHub push events and their associated commit data for any public repository. This Actor allows you to monitor repository activity, track user contributions, or gather data for analysis by specifying a date range.

The scraper is designed for performance and a great user experience:

- **⚡️ Direct & Fresh**: Your stream begins in about a minute, fetching data directly from the source.
- **📡 Continuous Live Feed**: Progressively fetches data as the stream runs, ideal for continuous monitoring.
- **🔧 Customizable Output**: Select only the fields you need in the output.

### Input Parameters

The Actor requires the following input:

| Field        | Type           | Description                                                                                                                |
| ------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `start_date` | Date           | **Required.** The first date to scrape data from, in `YYYY-MM-DD` format.                                                  |
| `end_date`   | Date           | **Optional.** The last date to scrape data from. If left blank, data will be scraped up to the most recent available hour. |
| `fields`     | Checkbox Group | **Optional.** Select the fields you want to include in the output. By default, all fields are selected.                    |

### Output Data

The Actor returns a dataset of GitHub push events. Each item in the dataset is a JSON object containing the fields you selected.

Here is an example of a single output record with all fields selected:

```json
{
  "PushId": 1234567890,
  "PushTimeStamp": "2025-07-28T10:30:00Z",
  "CommitMessage": "feat: Implement new user authentication flow",
  "CommitUrl": "https://github.com/user/repo/commit/a1b2c3d4e5f6",
  "CommitAuthorName": "Jane Doe",
  "CommitEmail": "jane.doe@example.com",
  "UserLogin": "janedoe",
  "UserEmail": "jane.doe@users.noreply.github.com",
  "UserUrl": "https://github.com/janedoe",
  "RepoUrl": "https://github.com/user/repo"
}
````

### Support

Find a bug or have a suggestion? Let me know!

# Actor input Schema

## `start_date` (type: `string`):

Required. The first date to scrape data from (YYYY-MM-DD)

## `end_date` (type: `string`):

Optional. If blank, scrapes up to the most recent available data.

## `output_fields` (type: `array`):

Select the fields you want to include in the output.

## Actor input object example

```json
{
  "start_date": "2025-08-01",
  "end_date": "2025-08-01",
  "output_fields": [
    "PushId",
    "PushTimeStamp",
    "CommitMessage",
    "CommitUrl",
    "CommitAuthorName",
    "CommitEmail",
    "UserLogin",
    "UserEmail",
    "UserUrl",
    "RepoUrl"
  ]
}
```

# 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 = {
    "start_date": "2025-08-01",
    "end_date": "2025-08-01",
    "output_fields": [
        "PushId",
        "PushTimeStamp",
        "CommitMessage",
        "CommitUrl",
        "CommitAuthorName",
        "CommitEmail",
        "UserLogin",
        "UserEmail",
        "UserUrl",
        "RepoUrl"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("krab/github-push-event-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 = {
    "start_date": "2025-08-01",
    "end_date": "2025-08-01",
    "output_fields": [
        "PushId",
        "PushTimeStamp",
        "CommitMessage",
        "CommitUrl",
        "CommitAuthorName",
        "CommitEmail",
        "UserLogin",
        "UserEmail",
        "UserUrl",
        "RepoUrl",
    ],
}

# Run the Actor and wait for it to finish
run = client.actor("krab/github-push-event-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 '{
  "start_date": "2025-08-01",
  "end_date": "2025-08-01",
  "output_fields": [
    "PushId",
    "PushTimeStamp",
    "CommitMessage",
    "CommitUrl",
    "CommitAuthorName",
    "CommitEmail",
    "UserLogin",
    "UserEmail",
    "UserUrl",
    "RepoUrl"
  ]
}' |
apify call krab/github-push-event-scraper --silent --output-dataset

```

## MCP server setup

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

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "GitHub Push Event Scraper",
        "description": "Extracts GitHub push events with your specified date range. Scrapes commit metadata, including author info (name, email), commit messages, and URLs for users, commits, and repos. Ideal for monitoring repository activity or tracking user contributions.",
        "version": "1.0",
        "x-build-id": "IxywFx1iKye44WoTg"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/krab~github-push-event-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-krab-github-push-event-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/krab~github-push-event-scraper/runs": {
            "post": {
                "operationId": "runs-sync-krab-github-push-event-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/krab~github-push-event-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-krab-github-push-event-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": [
                    "start_date"
                ],
                "properties": {
                    "start_date": {
                        "title": "Start Date",
                        "type": "string",
                        "description": "Required. The first date to scrape data from (YYYY-MM-DD)"
                    },
                    "end_date": {
                        "title": "End Date",
                        "type": "string",
                        "description": "Optional. If blank, scrapes up to the most recent available data."
                    },
                    "output_fields": {
                        "title": "Output Fields",
                        "type": "array",
                        "description": "Select the fields you want to include in the output.",
                        "items": {
                            "type": "string",
                            "enum": [
                                "PushId",
                                "PushTimeStamp",
                                "CommitMessage",
                                "CommitUrl",
                                "CommitAuthorName",
                                "CommitEmail",
                                "UserLogin",
                                "UserEmail",
                                "UserUrl",
                                "RepoUrl"
                            ]
                        }
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
