Example
curl 'https://socialtap.dev/v1/github/following?handle=defunkt' \
-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.following.list({ handle: "defunkt" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);const params = new URLSearchParams({
handle: "defunkt",
});
const res = await fetch(`https://socialtap.dev/v1/github/following?${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/following",
params={"handle": "defunkt"},
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", "defunkt")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/github/following?"+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' => 'defunkt',
]);
$ch = curl_init('https://socialtap.dev/v1/github/following?' . $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/following")
uri.query = URI.encode_www_form('handle' => 'defunkt')
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("defunkt");
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://socialtap.dev/v1/github/following?" + 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("defunkt"));
var res = await http.GetAsync("https://socialtap.dev/v1/github/following?" + 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/following")
.query(&[("handle", "defunkt")])
.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": [
{
"approximate_fields": [],
"avatar_url": "https://avatars.githubusercontent.com/u/1?v=4",
"banner_url": null,
"bio": null,
"category": null,
"country_code": null,
"created_at": null,
"display_name": null,
"external_links": [],
"id": "1",
"is_private": false,
"is_verified": null,
"location": null,
"metrics": {
"follower_count": null,
"following_count": null,
"post_count": null,
"total_like_count": null,
"total_view_count": null
},
"platform": "github",
"platform_specific": {
"github": {
"account_type": "user",
"archived_at": null,
"company": null,
"contribution_count": null,
"email": null,
"is_hireable": null,
"is_site_admin": false,
"node_id": "MDQ6VXNlcjE=",
"popular_repository": null,
"public_gist_count": null,
"public_repo_count": null,
"twitter_username": null,
"updated_at": null
}
},
"type": "person",
"unknown_fields": [
"external_links"
],
"url": "https://github.com/mojombo",
"username": "mojombo"
},
{
"approximate_fields": [],
"avatar_url": "https://avatars.githubusercontent.com/u/3?v=4",
"banner_url": null,
"bio": null,
"category": null,
"country_code": null,
"created_at": null,
"display_name": null,
"external_links": [],
"id": "3",
"is_private": false,
"is_verified": null,
"location": null,
"metrics": {
"follower_count": null,
"following_count": null,
"post_count": null,
"total_like_count": null,
"total_view_count": null
},
"platform": "github",
"platform_specific": {
"github": {
"account_type": "user",
"archived_at": null,
"company": null,
"contribution_count": null,
"email": null,
"is_hireable": null,
"is_site_admin": false,
"node_id": "MDQ6VXNlcjM=",
"popular_repository": null,
"public_gist_count": null,
"public_repo_count": null,
"twitter_username": null,
"updated_at": null
}
},
"type": "person",
"unknown_fields": [
"external_links"
],
"url": "https://github.com/pjhyett",
"username": "pjhyett"
},
{
"approximate_fields": [],
"avatar_url": "https://avatars.githubusercontent.com/u/17?v=4",
"banner_url": null,
"bio": null,
"category": null,
"country_code": null,
"created_at": null,
"display_name": null,
"external_links": [],
"id": "17",
"is_private": false,
"is_verified": null,
"location": null,
"metrics": {
"follower_count": null,
"following_count": null,
"post_count": null,
"total_like_count": null,
"total_view_count": null
},
"platform": "github",
"platform_specific": {
"github": {
"account_type": "user",
"archived_at": null,
"company": null,
"contribution_count": null,
"email": null,
"is_hireable": null,
"is_site_admin": false,
"node_id": "MDQ6VXNlcjE3",
"popular_repository": null,
"public_gist_count": null,
"public_repo_count": null,
"twitter_username": null,
"updated_at": null
}
},
"type": "person",
"unknown_fields": [
"external_links"
],
"url": "https://github.com/vanpelt",
"username": "vanpelt"
}
],
"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": "2",
"url": "https://github.com/defunkt"
},
"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, which survives a rename; or its link (github.com/sindresorhus, with any tab such as ?tab=following, api.github.com/users/<username>, gist.github.com/<username>).
Examplesindresorhus
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 profile objects, by account ID, oldest accounts first (the page source: github.com's own order, the latest follows first as far as seen); page says how to get the next page; meta describes the request (meta). Fields only GitHub has are under platform_specific.github.
platformstringPlatform ID (tiktok, youtube, …).
idstringPlatform-native account ID (string; YouTube UC…, Reddit t2_…).
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name, channel title or page name; null when empty or not exposed.
urlstring uriCanonical profile URL.
typestringCoarse account kind, as the platform labels it; unknown when it does not (TikTok labels organizations only). New values may be added; treat unknown values as unknown.
One ofpersonorganizationcommunityunknown
biostringnullableProfile bio, channel description or page about text; null when empty or not exposed.
avatar_urlstring urinullableProfile picture URL (largest available). Platform CDN URLs can expire within hours.
banner_urlstring urinullableHeader or cover image URL.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
is_privatebooleannullableTrue when the account's posts are not public.
categorystringnullablePlatform category label (e.g. Musician, Media & Entertainment), as shown; not normalized. Often set only for business or creator accounts.
external_linksobject[]Links in the bio or channel links; [] if none or not exposed.
ShowHide 2 child fields
urlstring uriLink target, absolute (https:// is added where the platform stores the link without a scheme).
titlestringnullableLink label shown by the platform.
locationstringnullableSelf-declared location text.
country_codestringnullableISO 3166-1 alpha-2 country the platform states for the account.
created_atstring date-timenullableAccount creation or join date, RFC 3339 UTC (some platforms give only the day: see approximate_fields).
metricsobjectCounts at fetch time; null = hidden or not exposed, 0 = zero.
ShowHide 5 child fields
follower_countintegernullableFollowers or subscribers.
following_countintegernullableAccounts this profile follows.
post_countintegernullablePosts or videos as the platform counts them on the profile (for a private account, posts the caller cannot see).
total_like_countintegernullableLikes received across all of the profile's posts (not likes given).
total_view_countintegernullableLifetime views across all of the profile's posts.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 1 child field
githubobjectnullableA GitHub user's, organization's or bot's own fields.
ShowHide 13 child fields
node_idstringnullableThe account's global node ID, as GitHub's GraphQL API keys it (MDQ6VXNlcjEwMjQwMjU=); null when the profile page answered instead of the API.
account_typestringnullableWhat kind of GitHub account it is: user, organization or bot (an app's account, such as dependabot[bot]). New values may be added; treat unknown values as other.
One ofuserorganizationbot
companystringnullableThe company the account names on its profile, as written (an @mention of an organization included); null when it names none.
emailstringnullableThe email address the account chose to show on its profile; null when it shows none.
twitter_usernamestringnullableThe X (Twitter) username the account links, without the @; null when it links none.
public_repo_countintegernullableHow many public repositories the account owns.
public_gist_countintegernullableHow many public gists the account owns; null when the profile page answered instead of the API.
is_site_adminbooleannullableTrue for GitHub staff accounts; null when the profile page answered instead of the API.
is_hireablebooleannullableTrue when the user marked itself available for hire; null on an organization or bot, or when the profile page answered instead of the API.
updated_atstring date-timenullableWhen the account's profile last changed, RFC 3339 UTC; null when the profile page answered instead of the API.
archived_atstring date-timenullableWhen the organization was archived (read-only), RFC 3339 UTC; null when it is not archived, and on a user or bot.
contribution_countintegernullableHow many commits to the repository GitHub credits the account with, on a repository's list of contributors (github.repository_contributors); null on every other answer.
popular_repositoryobjectnullableThe repository GitHub's trending developers board shows as the developer's popular repo; null when the board shows none for the developer, and on every endpoint but the trending board.
ShowHide 6 child fields
idstringnullableGitHub's numeric repository ID, as Repository.id; null when the board's row doesn't name it.
full_namestringOwner and name as in its link (torvalds/linux); the owner can be an organization rather than the developer.
namestringThe repository's name without its owner (linux), as its link spells it.
urlstring uriCanonical repository page URL.
ownerobjectThe account that owns it, as Repository.owner: the developer, or an organization (then only its username and url are known).
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.
descriptionstringnullableThe repository's description as the board shows it: GitHub cuts a long one short, ending it with an ellipsis (the Repository API has it whole); null when it has none.
approximate_fieldsstring[]JSON paths of values rounded by the platform or parsed from display text (e.g. metrics.follower_count). A list path (external_links) means the list may be incomplete. [] when all exact.
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); 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, by account ID, oldest accounts first (the page source: github.com's own order, the latest follows first as far as seen). 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/following?handle=defunkt&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.following · operationId github.following.list · Product overview