User activity

Try in Playground

Retrieve monthly contribution activity with summaries, repositories and dates. Choose native or camelCase fields with format.

GET/v1/github/user/activityx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

handlestringquery

GitHub handle, optionally beginning with @; 1–39 characters excluding @.

Exampleexample

urlstringquery

Canonical HTTPS github.com URL of the user, repository or issue required by this route.

max 2048 chars

yearstringquery

Calendar year 2007 through the current UTC year.

Example2025

cursorstringquery

One-based page cursor; activity cursors step backward by month.

formatenumquery

Response projection: native (default), normalized or camelCase where listed.

one of: native, camelCase

Response fields

platformstringoptional

Optional.

endpointstringoptional

Optional.

successboolean

Whether retrieval returned usable data.

statusenum

success, partial, failed or challenged.

one of: success, partial

requestIdstring

Request correlation UUID.

sourceUrlstring

Public source URL.

absolute HTTPS URL

fetchedAtstring

UTC fetch time.

Completeness of this bounded response, not complete account enumeration.

coverage.sourceenum

Always included.

one of: public_api, public_html

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

Combined upstream attempts, decoded bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

usernamestring

Always included.

yearinteger

Calendar year 2007 through the current UTC year.

monthstring

Always included.

activity.summarystring

Always included.

activity.details.textstring

Always included.

activity.details.repository.textstring

Always included.

activity.details.repository.urlstring

Always included.

absolute HTTPS URL

Always included.

activity.details.links.textstring

Always included.

activity.details.links.urlstring

Always included.

absolute HTTPS URL

activity.details.languagestringnullable

Always included.

activity.details.date_textstringnullable

Always included.

activity.details.date_descriptionstringnullable

Always included.

no_activityboolean

Always included.

messagestringnullable

Always included.

cursorintegernullable

One-based page cursor; activity cursors step backward by month.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Invalid, duplicate or unsupported parameters.
401	`unauthorized`	Invalid worker key.
404	`not_found`	Public source record unavailable; SocialFetch aliases return data.lookupStatus=not_found with HTTP 200.
429	`upstream_rate_limited`	GitHub throttled retrieval.
502	`upstream_error` `upstream_challenged` `unsupported_page`	Source retrieval failed or the source contract changed.
502	`unsafe_redirect` `response_too_large` `payload_too_complex` `request_limit`	A fixed safety or resource boundary was reached.
503	`busy`	All worker slots are occupied.
504	`timeout`	Total deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/github/user/activity?handle=example&year=2025" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/github/user/activity?handle=example&year=2025",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/github/user/activity?handle=example&year=2025",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`GitHub request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/github/user/activity",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "handle": "example",
        "year": "2025"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/github/user/activity?handle=example&year=2025", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/github/user/activity?handle=example&year=2025"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "username": "example",
  "year": 2025,
  "month": "December 2025",
  "activity": [
    {
      "summary": "Created 17 commits in 1 repository",
      "details": [
        {
          "text": "example/repo 17 commits TypeScript Dec 1",
          "repository": {
            "text": "example/repo",
            "url": "https://github.com/example/repo"
          },
          "links": [
            {
              "text": "example/repo",
              "url": "https://github.com/example/repo"
            },
            {
              "text": "17 commits",
              "url": "https://github.com/example/repo/commits"
            }
          ],
          "language": "TypeScript",
          "date_text": "Dec 1",
          "date_description": "December 1, 2025"
        }
      ]
    }
  ],
  "no_activity": false,
  "message": null,
  "cursor": 2,
  "platform": "github",
  "endpoint": "/v1/github/user/activity",
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "sourceUrl": "https://github.com/example?action=show&controller=profiles&tab=contributions&user_id=example&from=2025-12-01&to=2025-12-31",
  "fetchedAt": "2026-09-17T00:00:00.000Z",
  "coverage": {
    "source": "public_html",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 550,
    "durationMs": 1
  }
}

Invalid, duplicate or unsupported parameters.

{
  "platform": "github",
  "endpoint": "string",
  "success": true,
  "status": "success",
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "sourceUrl": "https://example.com/",
  "fetchedAt": "2026-01-01T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": [
      "string"
    ]
  },
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "data": {
    "lookupStatus": "found",
    "username": "string",
    "year": 0,
    "month": "string",
    "activity": [
      {
        "summary": "string",
        "details": [
          {
            "text": null,
            "repository": null,
            "links": null,
            "language": null,
            "dateText": null,
            "dateDescription": null
          }
        ]
      }
    ],
    "noActivity": true,
    "message": "string",
    "page": {
      "nextCursor": "string",
      "hasMore": true
    }
  }
}