Example
curl 'https://socialtap.dev/v1/github/activity?handle=gaearon' \
-H "x-api-key: $SOCIALTAP_API_KEY"import { SocialTap } from "socialtap";
const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY
const res = await client.github.activity.list({ handle: "gaearon" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
handle: "gaearon",
});
const res = await fetch(`https://socialtap.dev/v1/github/activity?${params}`, {
headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);import os
import requests
res = requests.get(
"https://socialtap.dev/v1/github/activity",
params={"handle": "gaearon"},
headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"net/url"
"os"
)
func main() {
q := url.Values{}
q.Set("handle", "gaearon")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/github/activity?"+q.Encode(), nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatal(err)
}
defer res.Body.Close()
var body struct {
Data json.RawMessage `json:"data"`
Page json.RawMessage `json:"page"`
Meta map[string]any `json:"meta"`
Error *struct {
Code string `json:"code"`
Message string `json:"message"`
} `json:"error"`
}
if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
log.Fatal(err)
}
if body.Error != nil {
log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
}
fmt.Println(string(body.Data), body.Meta["credits_charged"])
}<?php
$query = http_build_query([
'handle' => 'gaearon',
]);
$ch = curl_init('https://socialtap.dev/v1/github/activity?' . $query);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;require "json"
require "net/http"
uri = URI("https://socialtap.dev/v1/github/activity")
uri.query = URI.encode_www_form('handle' => 'gaearon')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
public class Main {
public static void main(String[] args) throws Exception {
String query = "handle=" + encode("gaearon");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/github/activity?" + query))
.header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
// An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
if (response.statusCode() >= 400) throw new RuntimeException(response.body());
System.out.println(response.body());
}
static String encode(String value) {
return URLEncoder.encode(value, StandardCharsets.UTF_8);
}
}using System.Text.Json;
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));
var query = string.Join("&",
"handle=" + Uri.EscapeDataString("gaearon"));
var res = await http.GetAsync("https://socialtap.dev/v1/github/activity?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
var error = body.RootElement.GetProperty("error");
throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let res = reqwest::blocking::Client::new()
.get("https://socialtap.dev/v1/github/activity")
.query(&[("handle", "gaearon")])
.header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
.send()?;
let ok = res.status().is_success();
let body: serde_json::Value = res.json()?;
if !ok {
return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
}
println!("{} {}", body["data"], body["meta"]["credits_charged"]);
Ok(())
}{
"data": [
{
"action": "opened",
"actor": {
"avatar_url": "https://avatars.githubusercontent.com/u/810438?",
"display_name": null,
"id": "810438",
"is_verified": null,
"url": "https://github.com/gaearon",
"username": "gaearon"
},
"approximate_fields": [],
"created_at": "2026-11-13T01:13:31Z",
"head_sha": null,
"id": "19964384385",
"metrics": {
"commit_count": null
},
"platform": "github",
"platform_specific": {
"github": {
"period_start_at": null,
"repository_language": null
}
},
"platform_type": "PullRequestEvent",
"ref": null,
"ref_type": null,
"repository": {
"full_name": "vercel/next.js",
"id": "70107786",
"url": "https://github.com/vercel/next.js"
},
"target": {
"id": "5288159677",
"number": 101709,
"title": null,
"type": "pull_request",
"url": "https://github.com/vercel/next.js/pull/101709"
},
"text": null,
"type": "pull_request",
"unknown_fields": [],
"url": "https://github.com/vercel/next.js/pull/101709"
},
{
"action": "opened",
"actor": {
"avatar_url": "https://avatars.githubusercontent.com/u/810438?",
"display_name": null,
"id": "810438",
"is_verified": null,
"url": "https://github.com/gaearon",
"username": "gaearon"
},
"approximate_fields": [],
"created_at": "2026-11-13T01:12:54Z",
"head_sha": null,
"id": "19964340602",
"metrics": {
"commit_count": null
},
"platform": "github",
"platform_specific": {
"github": {
"period_start_at": null,
"repository_language": null
}
},
"platform_type": "PullRequestEvent",
"ref": null,
"ref_type": null,
"repository": {
"full_name": "vercel/next.js",
"id": "70107786",
"url": "https://github.com/vercel/next.js"
},
"target": {
"id": "5288153906",
"number": 101708,
"title": null,
"type": "pull_request",
"url": "https://github.com/vercel/next.js/pull/101708"
},
"text": null,
"type": "pull_request",
"unknown_fields": [],
"url": "https://github.com/vercel/next.js/pull/101708"
},
{
"action": "opened",
"actor": {
"avatar_url": "https://avatars.githubusercontent.com/u/810438?",
"display_name": null,
"id": "810438",
"is_verified": null,
"url": "https://github.com/gaearon",
"username": "gaearon"
},
"approximate_fields": [],
"created_at": "2026-11-12T16:51:01Z",
"head_sha": null,
"id": "19917831655",
"metrics": {
"commit_count": null
},
"platform": "github",
"platform_specific": {
"github": {
"period_start_at": null,
"repository_language": null
}
},
"platform_type": "PullRequestEvent",
"ref": null,
"ref_type": null,
"repository": {
"full_name": "vercel/next.js",
"id": "70107786",
"url": "https://github.com/vercel/next.js"
},
"target": {
"id": "5281534449",
"number": 101677,
"title": null,
"type": "pull_request",
"url": "https://github.com/vercel/next.js/pull/101677"
},
"text": null,
"type": "pull_request",
"unknown_fields": [],
"url": "https://github.com/vercel/next.js/pull/101677"
}
],
"page": {
"has_more": true,
"next_cursor": "c1.EXAMPLE_CURSOR",
"next_cursor_expires_at": "2026-10-26T12:00:00Z",
"end_reason": null
},
"meta": {
"request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
"platform": "github",
"source": "api",
"is_cached": false,
"credits_charged": 1,
"latency_ms": 1000,
"fetched_at": "2026-10-25T12:00:00Z",
"input": {
"kind": "profile",
"id": "810438",
"url": "https://github.com/gaearon"
},
"credits_remaining": 9999,
"client_request_id": null,
"warnings": []
}
}Long arrays and strings are shortened for display; real responses are complete.
The GitHub account: its username (login), with or without the @; its numeric account ID; or its link (github.com/torvalds, with any tab, github.com/orgs/github, a bot's github.com/apps/dependabot, api.github.com/users/<username>).
Exampletorvalds
Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged. Only activity at or after this time. A date more than 90 days back reads the monthly contribution timeline instead of the event feed: the walk then goes back month by month and stops once it passes this date.
Example2026-10-01
Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). Only activity before this time. A date more than 90 days back reads the monthly contribution timeline from that month backwards (send the first day of a year to read that year and older).
Example2026-10-08
Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.
Example100
cursorstringpage.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.
handle takes GitHub profile links; another kind of link, or another platform's, fails free with invalid_input. Unknown parameters are rejected with a suggestion, never ignored (Requests). limit and cursor page through the list: see Pagination.
Parameters every endpoint accepts
Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent.
fieldsstringReturn only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole.
Response
200
{data, page, meta}. data is an array of up to 100 activity objects, newest first; page says how to get the next page; meta describes the request (meta). Fields only GitHub has are under platform_specific.github.
platformstringPlatform ID (github, …).
idstringThe activity's ID: the platform's own event ID, else one derived from the repository, the kind and the month the platform groups it in (torvalds/linux:push:2026-05), stable across fetches.
typestringWhat the account did: push (commits to a branch or tag), create and delete (a repository, branch or tag: ref_type), fork, star, watch (subscribed to a repository's notifications), issue and pull_request (opened, closed, merged…: action), review (of a pull request), comment (on an issue, pull request or commit), release, member (added to or left a repository or group), wiki (edited its pages), discussion; other: the platform's own kind in platform_type. New values may be added; treat any other value as other.
One ofpushcreatedeleteforkstarwatchissuepull_requestreviewcommentreleasememberwikidiscussionother
platform_typestringnullableThe platform's own name for the kind (PushEvent on GitHub, "pushed to" on GitLab, commit_repo on Codeberg); null when the source shows none.
actionstringnullableWhat happened to the target, for kinds with more than one action: opened, closed, reopened, merged, edited, created, deleted, published (a release), approved, changes_requested, commented, dismissed (a review), ready_for_review, added and removed (a member), joined and left, assigned, unassigned, labeled, unlabeled, review_requested, synchronized (new commits on a pull request). Null for a kind that is its own action (push, star, fork) or when not shown. New values may be added; treat any other value as null.
One ofopenedclosedreopenedmergededitedcreateddeletedpublishedapprovedchanges_requestedcommenteddismissedready_for_reviewaddedremovedjoinedleftassignedunassignedlabeledunlabeledreview_requestedsynchronized
created_atstring date-timeWhen it happened, RFC 3339 UTC, never later than the fetch. A date-only value is listed in approximate_fields; an item grouping a period's commits (GitHub's contribution timeline) is dated by the period's last day, or the day of the fetch while the period runs.
actorobjectThe account that acted; fields null when not shown.
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
repositoryobjectnullableThe repository it happened in (for a fork, the one forked; for a create of a repository, the new one); null when it happened in none (joining a group).
ShowHide 3 child fields
idstringnullablePlatform-native repository ID (string); null when the source names it by path only.
full_namestringnullableThe repository's path, owner and name (torvalds/linux; nested groups on GitLab: group/subgroup/name); null when the source gives its ID only.
urlstring urinullableThe repository's page (https://github.com/torvalds/linux); null when unknown.
refstringnullableThe branch or tag pushed to, created or deleted, by its short name (main, v1.2.0; never refs/heads/…); null for other kinds and a created repository.
ref_typestringnullableWhat ref names, or what was created or deleted: branch, tag, or repository (a create or delete of the repository itself, with ref null); null for other kinds. New values may be added; treat any other value as null.
One ofbranchtagrepository
head_shastringnullableFor a push, or a create of a branch or tag by a push, the commit the branch or tag points to after it (a full hexadecimal commit hash); null for other kinds or when not shown.
targetobjectnullableWhat the action was on, beyond the repository: the issue, pull request, release, discussion, wiki page or commit, the fork created, the member added; null for a push, a star and a create or delete of a ref.
ShowHide 5 child fields
typestringThe kind of thing acted on: issue, pull_request (a GitLab merge request), release, discussion, wiki_page, commit (a commit comment), repository (the fork created), profile (the member added); other: a platform's own kind. New values may be added; treat any other value as other.
One ofissuepull_requestreleasediscussionwiki_pagecommitrepositoryprofileother
idstringnullableThe target's platform-native ID (a commit's hash); null when not shown.
numberintegernullableAn issue's, pull request's or discussion's number in its repository (#1089); null for other targets.
titlestringnullableThe target's title as the platform shows it (an issue's or pull request's title, a release's name, the fork's path, the member's username); null when the source does not carry it (GitHub's events omit a pull request's title).
urlstring urinullableThe target's page; null when unknown.
textstringnullableWhat the account wrote in this action: a comment's or a review's body, as plain text or Markdown as the platform holds it; null for kinds with no text of their own or an empty review.
urlstring urinullableThe page that shows what was done: the comment, the issue or pull request, the release, the pushed commits, the fork, else the repository; null when there is none.
metricsobjectCounts of this action; null = not shown, 0 = zero.
ShowHide 1 child field
commit_countintegernullableFor a push, or a create of a branch or tag by a push, the commits it added (for a period's group, the commits in the period); null for other kinds or when the platform does not say.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 1 child field
githubobjectnullableGitHub's own fields.
ShowHide 2 child fields
period_start_atstring date-timenullableFor an item that groups the commits an account made to one repository in a month (GitHub's contribution timeline), the month's first day, RFC 3339 UTC; created_at is then the month's last day, or the day of the fetch for the month still running. Null for a single action.
repository_languagestringnullableFor a created repository on the contribution timeline, its main language as GitHub shows it (JavaScript); null for other items and on the event feed.
approximate_fieldsstring[]JSON paths of values the platform gives only by day or month (created_at on GitHub's contribution timeline). [] when all exact.
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none; null already means unknown for every other field. [] when every list is known.
not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.
400
400 Bad Request: 2 error codes. Free: errors cost nothing.
invalid_inputNo retryA parameter is missing or malformed, or the link is not one this endpoint takes.
Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.
invalid_cursorNo retryThe cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.
Repeat the original request without cursor to start the list again.
401
401 Unauthorized: 1 error code. Free: errors cost nothing.
unauthorizedNo retryThe x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.
Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.
402
402 Payment Required: 2 error codes. Free: errors cost nothing.
insufficient_creditsNo retryThe account does not have enough credits for this request.
Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.
spend_limit_reachedNo retryThe API key reached its spend limit for this period. The account may still have credits.
Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically.
403
403 Forbidden: 2 error codes. Free: errors cost nothing.
forbiddenNo retryThe API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.
Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.
404
404 Not Found: 1 error code. Free: errors cost nothing.
not_foundNo retryThe item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).
Check the link or ID. Do not retry.
429
429 Too Many Requests: 1 error code. Free: errors cost nothing.
rate_limitedYes, laterThe account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.
Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.
451
451: 1 error code. Free: errors cost nothing.
500
500 Internal Error: 1 error code. Free: errors cost nothing.
internalYes, laterAn unexpected error on SocialTap's side.
Retry with backoff. If it keeps happening, contact support with the request_id.
502
502 Bad Gateway: 1 error code. Free: errors cost nothing.
upstream_errorYes, laterThe platform failed, or answered with something we could not read.
Retry with backoff. Failed requests are free.
503
503 Unavailable: 2 error codes. Free: errors cost nothing.
upstream_blockedYes, laterThe platform refused every attempt, our own retries included.
Retry later with backoff. Failed requests are free.
overloadedYes, laterSocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.
Retry after the seconds in the retry-after header. Failed requests are free.
Items come in pages, newest first. To get the next page, send the same request plus cursor set to page.next_cursor from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When page.has_more is false the walk is over, and page.end_reason says why: only end means you have every item (the others say the platform or a page cap stopped the walk early).
The page object
has_morebooleanTrue when another page exists; then next_cursor is set. An empty page with has_more true is not the end.
next_cursorstringnullablePass as cursor, with the same other parameters, to get the next page; null at the end.
next_cursor_expires_atstring date-timenullableWhen next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.
end_reasonstringnullableWhy there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.
One ofendplatform_limitmax_pages
Next page
curl 'https://socialtap.dev/v1/github/activity?handle=gaearon&cursor=c1.EXAMPLE_CURSOR' \
-H "x-api-key: $SOCIALTAP_API_KEY"- The price is per page: each successful page costs the same, whatever
limitis and however many items it has. Empty pages are charged too (an empty page withhas_more: trueis not the end). - A
limitbelow 100 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omittinglimitis the cheapest way to walk the list. - Errors are free, including a rejected cursor.
- Pages served from the cache are free.
- An expired or altered cursor, or one sent with different parameters, fails with
invalid_cursor(HTTP 400): Repeat the original request without cursor to start the list again.
From 1 credit per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as meta.source; sources are tried cheapest first: Platform API → Public page.
| Source | Price per successful page | Per 1,000 pages |
|---|---|---|
Platform API api | 1 credit | $0.75–$1.97 |
Public page page | 1 credit | $0.75–$1.97 |
Balance, sources and what you were charged
Your balance must be at least 1 credit to start a request; with less, it is refused with insufficient_credits (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.
| meta.source | Source | What it means |
|---|---|---|
api | Platform API | The platform's public, logged-out API. |
page | Public page | Data embedded in the platform's public web page. |
meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs
Endpoint ID github.activity · operationId github.activity.list · Product overview