Tutorial · GitHub

📘 TypeScript Step-by-step

How to scrape GitHub activities
with TypeScript.

Extract activity data from GitHub. Real code, real responses, real production patterns — paste it into your project and ship.

All tutorials GitHub API ~15 min read

Overview

Learn how to scrape GitHub activities using TypeScript. This comprehensive guide will walk you through the entire process, from setup to implementation.

What You'll Learn

• Setting up your development environment
• Installing the required HTTP client
• Authenticating with the ScrapeCreators API
• Making requests to GitHub
• Handling responses and errors
• Best practices for production use

What You'll Get

• Access to activities data
• JSON formatted responses
• Real-time data access
• Scalable solution
• Error handling patterns
• Performance optimization tips

Prerequisites

1. API Key

First, you'll need a ScrapeCreators API key to authenticate your requests.

2. Development Environment

Make sure you have the following installed:

• TypeScript and its dependencies
• A code editor (VS Code, Sublime, etc.)
• Basic understanding of API requests
• Command line interface access

Step 1: Install HTTP Client

Axios is a promise-based HTTP client for TypeScript/JavaScript

npm

npm install axios

Step 2: API Implementation

Now let's make a request to the GitHub API using TypeScript. Replace YOUR_API_KEY with your actual API key.

TypeScript

import axios from 'axios';

interface ScrapeParams {
    handle: string;
    url: string;
    year: string;
    cursor: string;
}

const API_KEY = 'YOUR_API_KEY';

async function scrape(params: ScrapeParams): Promise<any> {
    try {
        const response = await axios.get(`https://api.scrapecreators.com/v1/github/user/activity?handle=kentcdodds&url=https://github.com/torvalds&year=2026&cursor=1`, {
            headers: {
                'x-api-key': API_KEY,
                'Content-Type': 'application/json'
            },
        });

        console.log('Response:', response.data);
        return response.data;
    } catch (error) {
        console.error('Error:', error.response?.data || error.message);
        throw error;
    }
}

// Usage
const params: ScrapeParams = {
    handle: 'kentcdodds',
    url: 'https://github.com/torvalds',
    year: '2026',
    cursor: '1'
};

scrape(params);

Step 3: Testing Your Code

API Parameters

This endpoint accepts the following parameters:

handleOptional(string)

GitHub handle

Example: kentcdodds

urlOptional(string)

GitHub user URL, e.g. https://github.com/kentcdodds.

Example: https://github.com/torvalds

yearOptional(number)

When provided, returns profile contribution activity for that year. Defaults to the current year.

Example: 2026

cursorOptional(number)

Cursor from the previous response. Pages backward by month through the selected year.

Example: 1

Run Your Code

Execute your script to test the API connection. You should see a JSON response with GitHub activities data.

✅ Success: You should receive a structured JSON response containing the requested data.

Expected Response

Here's an example of the JSON response you'll receive:

Sample Response

{
  "success": true,
  "credits_remaining": 49997684632,
  "username": "kentcdodds",
  "year": 2026,
  "month": "May 2026",
  "activity": [
    {
      "summary": "Created 186 commits in 13 repositories",
      "details": [
        {
          "text": "kentcdodds/kody 144 commits",
          "repository": {
            "text": "kentcdodds/kody",
            "url": "https://github.com/kentcdodds/kody"
          },
          "links": [
            {
              "text": "kentcdodds/kody",
              "url": "https://github.com/kentcdodds/kody"
            },
            {
              "text": "144 commits",
              "url": "https://github.com/kentcdodds/kody/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "kody-bot/connector-kit 9 commits",
          "repository": {
            "text": "kody-bot/connector-kit",
            "url": "https://github.com/kody-bot/connector-kit"
          },
          "links": [
            {
              "text": "kody-bot/connector-kit",
              "url": "https://github.com/kody-bot/connector-kit"
            },
            {
              "text": "9 commits",
              "url": "https://github.com/kody-bot/connector-kit/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "kentcdodds/kentcdodds.com 8 commits",
          "repository": {
            "text": "kentcdodds/kentcdodds.com",
            "url": "https://github.com/kentcdodds/kentcdodds.com"
          },
          "links": [
            {
              "text": "kentcdodds/kentcdodds.com",
              "url": "https://github.com/kentcdodds/kentcdodds.com"
            },
            {
              "text": "8 commits",
              "url": "https://github.com/kentcdodds/kentcdodds.com/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "kentcdodds/stream-systems-visual 8 commits",
          "repository": {
            "text": "kentcdodds/stream-systems-visual",
            "url": "https://github.com/kentcdodds/stream-systems-visual"
          },
          "links": [
            {
              "text": "kentcdodds/stream-systems-visual",
              "url": "https://github.com/kentcdodds/stream-systems-visual"
            },
            {
              "text": "8 commits",
              "url": "https://github.com/kentcdodds/stream-systems-visual/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "kentcdodds/kody-home-connector 6 commits",
          "repository": {
            "text": "kentcdodds/kody-home-connector",
            "url": "https://github.com/kentcdodds/kody-home-connector"
          },
          "links": [
            {
              "text": "kentcdodds/kody-home-connector",
              "url": "https://github.com/kentcdodds/kody-home-connector"
            },
            {
              "text": "6 commits",
              "url": "https://github.com/kentcdodds/kody-home-connector/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "kentcdodds/kids-ledger 3 commits",
          "repository": {
            "text": "kentcdodds/kids-ledger",
            "url": "https://github.com/kentcdodds/kids-ledger"
          },
          "links": [
            {
              "text": "kentcdodds/kids-ledger",
              "url": "https://github.com/kentcdodds/kids-ledger"
            },
            {
              "text": "3 commits",
              "url": "https://github.com/kentcdodds/kids-ledger/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "epicweb-dev/epicshop 2 commits",
          "repository": {
            "text": "epicweb-dev/epicshop",
            "url": "https://github.com/epicweb-dev/epicshop"
          },
          "links": [
            {
              "text": "epicweb-dev/epicshop",
              "url": "https://github.com/epicweb-dev/epicshop"
            },
            {
              "text": "2 commits",
              "url": "https://github.com/epicweb-dev/epicshop/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "epicweb-dev/eprec 1 commit",
          "repository": {
            "text": "epicweb-dev/eprec",
            "url": "https://github.com/epicweb-dev/eprec"
          },
          "links": [
            {
              "text": "epicweb-dev/eprec",
              "url": "https://github.com/epicweb-dev/eprec"
            },
            {
              "text": "1 commit",
              "url": "https://github.com/epicweb-dev/eprec/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "epicweb-dev/epicli 1 commit",
          "repository": {
            "text": "epicweb-dev/epicli",
            "url": "https://github.com/epicweb-dev/epicli"
          },
          "links": [
            {
              "text": "epicweb-dev/epicli",
              "url": "https://github.com/epicweb-dev/epicli"
            },
            {
              "text": "1 commit",
              "url": "https://github.com/epicweb-dev/epicli/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "epicweb-dev/remember 1 commit",
          "repository": {
            "text": "epicweb-dev/remember",
            "url": "https://github.com/epicweb-dev/remember"
          },
          "links": [
            {
              "text": "epicweb-dev/remember",
              "url": "https://github.com/epicweb-dev/remember"
            },
            {
              "text": "1 commit",
              "url": "https://github.com/epicweb-dev/remember/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "epicweb-dev/cachified 1 commit",
          "repository": {
            "text": "epicweb-dev/cachified",
            "url": "https://github.com/epicweb-dev/cachified"
          },
          "links": [
            {
              "text": "epicweb-dev/cachified",
              "url": "https://github.com/epicweb-dev/cachified"
            },
            {
              "text": "1 commit",
              "url": "https://github.com/epicweb-dev/cachified/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "epicweb-dev/react-e2e-testing-with-pl... 1 commit",
          "repository": {
            "text": "epicweb-dev/react-e2e-testing-with-pl...",
            "url": "https://github.com/epicweb-dev/react-e2e-testing-with-playwright"
          },
          "links": [
            {
              "text": "epicweb-dev/react-e2e-testing-with-pl...",
              "url": "https://github.com/epicweb-dev/react-e2e-testing-with-playwright"
            },
            {
              "text": "1 commit",
              "url": "https://github.com/epicweb-dev/react-e2e-testing-with-playwright/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        },
        {
          "text": "kentcdodds/mediarss 1 commit",
          "repository": {
            "text": "kentcdodds/mediarss",
            "url": "https://github.com/kentcdodds/mediarss"
          },
          "links": [
            {
              "text": "kentcdodds/mediarss",
              "url": "https://github.com/kentcdodds/mediarss"
            },
            {
              "text": "1 commit",
              "url": "https://github.com/kentcdodds/mediarss/commits?author=kentcdodds&since=2026-05-01&until=2026-05-22"
            }
          ],
          "language": null,
          "date_text": null,
          "date_description": null
        }
      ]
    },
    {
      "summary": "Created 2 repositories",
      "details": [
        {
          "text": "kentcdodds/stream-systems-visual TypeScript • Built by This contribution was made on May 19 May 19",
          "repository": {
            "text": "kentcdodds/stream-systems-visual",
            "url": "https://github.com/kentcdodds/stream-systems-visual"
          },
          "links": [
            {
              "text": "kentcdodds/stream-systems-visual",
              "url": "https://github.com/kentcdodds/stream-systems-visual"
            }
          ],
          "language": "TypeScript",
          "date_text": "May 19",
          "date_description": "This contribution was made on May 19"
        },
        {
          "text": "kentcdodds/kody-home-connector TypeScript • Built by This contribution was made on May 7 May 7",
          "repository": {
            "text": "kentcdodds/kody-home-connector",
            "url": "https://github.com/kentcdodds/kody-home-connector"
          },
          "links": [
            {
              "text": "kentcdodds/kody-home-connector",
              "url": "https://github.com/kentcdodds/kody-home-connector"
            }
          ],
          "language": "TypeScript",
          "date_text": "May 7",
          "date_description": "This contribution was made on May 7"
        }
      ]
    },
    {
      "summary": "31 contributions in private repositories May 5 – May 19",
      "details": []
    }
  ],
  "no_activity": false,
  "message": null,
  "cursor": 2
}

Verify Response Structure

Check that your response includes the expected fields:

✓success(boolean)
✓credits_remaining(number)
✓username(string)
✓year(number)
✓month(string)
... and 4 more fields

Best Practices

Error Handling

Implement comprehensive error handling and retry logic for failed requests. Log errors properly for debugging.

Caching

Cache responses when possible to reduce API calls and improve performance. Consider data freshness requirements.

Security

Never expose your API key in client-side code. Use environment variables and secure key management practices.

Performance Tips

Batch Requests

When scraping multiple activities, consider batching requests to maximize throughput while staying within rate limits.

Async Processing

Use asynchronous processing in TypeScript to handle multiple requests concurrently and improve overall performance.

Common Use Cases

Market Research

Analyze GitHub activities to understand market trends, competitor analysis, and audience insights.

Content Analytics

Track performance metrics, engagement rates, and content trends across GitHub activities.

Lead Generation

Identify potential customers and business opportunities throughGitHub data analysis.

Troubleshooting

Common Errors

401 Unauthorized

Check your API key is correct and properly formatted in the x-api-key header.

402 Payment Required

You ran out of credits and need to buy more.

404 Not Found

The resource might not exist or be private.

500 Server Error

Temporary server issue. Implement retry logic with exponential backoff.

Need Help?

Documentation More Tutorials

Frequently Asked Questions

How much does it cost to scrape GitHub activities?

ScrapeCreators offers 100 free API calls to get started. After that, pricing starts at $10 for 5k requests with volume discounts available.

Is it legal to scrape GitHub data?

Scraping publicly available data is fair game, and we only collect public data. So anything that you can see in an incognito browser is what we collect.

How fast can I scrape GitHub activities?

There is no rate limit! So you can scrape as fast as you want!

What data format does the API return?

All API responses are returned in JSON format, making it easy to integrate with any programming language or application.

Can I use this with other TypeScript frameworks?

Yes! This tutorial focuses on core TypeScript HTTP concepts that work with any framework. The API calls remain the same regardless of your specific TypeScript setup.

How do I handle large datasets?

For large datasets, implement pagination, use streaming responses where available, and consider storing data in a database for efficient querying.

Get the API key. Run the code.

100 free API calls. No credit card. Same endpoint, same response shape.

Start free — 100 credits View documentation →

Same endpoint, different language

Pick another stack.

⚡️ Node.js 🌐 JavaScript 🐍 Python 🐘 PHP 💎 Ruby ☕ Java 🎯 C# 🚀 Go 🦀 Rust 🍎 Swift 📱 Kotlin 📊 R

How to scrape GitHub activities with TypeScript.