Example
curl 'https://socialtap.dev/v1/github/contributions?handle=torvalds' \
-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.contributions.get({ handle: "torvalds" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
handle: "torvalds",
});
const res = await fetch(`https://socialtap.dev/v1/github/contributions?${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, meta } = body;
console.log(data, meta.credits_charged);import os
import requests
res = requests.get(
"https://socialtap.dev/v1/github/contributions",
params={"handle": "torvalds"},
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, meta = body["data"], 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", "torvalds")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/github/contributions?"+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"`
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' => 'torvalds',
]);
$ch = curl_init('https://socialtap.dev/v1/github/contributions?' . $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/contributions")
uri.query = URI.encode_www_form('handle' => 'torvalds')
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("torvalds");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/github/contributions?" + 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("torvalds"));
var res = await http.GetAsync("https://socialtap.dev/v1/github/contributions?" + 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/contributions")
.query(&[("handle", "torvalds")])
.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": {
"account": {
"avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
"display_name": null,
"id": "1024025",
"is_verified": null,
"url": "https://github.com/torvalds",
"username": "torvalds"
},
"approximate_fields": [],
"days": [
{
"date": "2025-11-09",
"level": 1,
"metrics": {
"contribution_count": 3
}
},
{
"date": "2025-11-10",
"level": 1,
"metrics": {
"contribution_count": 2
}
},
{
"date": "2025-11-11",
"level": 1,
"metrics": {
"contribution_count": 3
}
}
],
"end_date": "2026-11-13",
"metrics": {
"contribution_count": 4015
},
"platform": "github",
"platform_specific": {
"github": {
"code_review_percent": 0,
"commit_percent": 100,
"issue_percent": 0,
"pull_request_percent": 0
}
},
"start_date": "2025-11-09",
"unknown_fields": [],
"url": "https://github.com/torvalds",
"year": null
},
"meta": {
"request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
"platform": "github",
"source": "page",
"is_cached": false,
"credits_charged": 1,
"latency_ms": 1000,
"fetched_at": "2026-10-25T12:00:00Z",
"input": {
"kind": "profile",
"id": "1024025",
"url": "https://github.com/torvalds"
},
"credits_remaining": 9999,
"client_request_id": null,
"warnings": []
}
}Long arrays and strings are shortened for display; real responses are complete.
The GitHub user: its username, with or without the @; its numeric account ID, which survives a rename; or its profile link (github.com/torvalds, with any tab).
Exampletorvalds
A calendar year, January 1 to December 31 (the current one up to today). Leave it out for the last twelve months, the calendar GitHub shows on the profile.
Example2025
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).
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, meta}. data is a contribution calendar object; meta describes the request (meta). Fields only GitHub has are under platform_specific.github.
platformstringPlatform ID (github, …).
urlstring uriThe public page that shows this calendar: the account's page, with the period selected where the platform links one (GitHub's year links).
accountobjectThe account whose contributions these are; at least its username.
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.
yearintegernullableThe calendar year the period is, when it is one (January 1 to December 31, cut at today for the current year); null when the period is the trailing twelve months.
start_datestring dateFirst day of the period, YYYY-MM-DD (days[0].date).
end_datestring dateLast day of the period, inclusive, YYYY-MM-DD (the last of days[]); today when the period runs to now: days to come are never listed.
daysobject[]Every day of the period, oldest first, one per date from start_date to end_date: days without contributions included, with a count of 0.
ShowHide 3 child fields
datestring dateThe day, YYYY-MM-DD, as the platform buckets contributions (GitHub: UTC).
levelintegernullableThe shade the platform paints the day, 0 (no contributions) to 4 (its busiest), as it computes it; null when it shows none.
metricsobjectThe day's counts; null = the platform did not say, 0 = none.
ShowHide 1 child field
contribution_countintegernullableContributions that day as the platform counts them (GitHub: commits, issues, pull requests, reviews, and private ones when the account shows them); 0 when none.
metricsobjectThe period's totals; null = the platform did not say.
ShowHide 1 child field
contribution_countintegernullableContributions over the whole period, the sum of days[].metrics.contribution_count.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 1 child field
githubobjectnullableA GitHub calendar's own fields: its activity overview.
ShowHide 4 child fields
commit_percentintegernullableShare of the period's contributions that are commits, 0 to 100, as GitHub's activity overview rounds it; null when the account hides its overview.
issue_percentintegernullableShare that are issues opened, 0 to 100; null when the account hides its overview.
pull_request_percentintegernullableShare that are pull requests opened, 0 to 100; null when the account hides its overview.
code_review_percentintegernullableShare that are pull request reviews, 0 to 100; null when the account hides its overview.
approximate_fieldsstring[]JSON paths of values rounded or capped by the platform. [] when all exact (every platform's counts are exact today).
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none; days always lists the period, so always [].
not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.
400
400 Bad Request: 1 error code. 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.
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.
From 1 credit per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as meta.source.
| Source | Price per successful request | Per 1,000 requests |
|---|---|---|
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 |
|---|---|---|
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.contributions · operationId github.contributions.get · Product overview