# GitHub Profile API

GitHub

Returns a public GitHub account, a user, an organization or a bot, from its username, account ID or link. You get exact follower, following, repository and gist counts, the name, bio, company, location, website, X username, public email, avatar and join date, and an organization's verified badge. [Overview and pricing](https://socialtap.dev/apis/github/profile/index.md)

GET `/v1/github/profile`

## Example

cURL:

```shell
curl 'https://socialtap.dev/v1/github/profile?handle=torvalds' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

TypeScript SDK:

```typescript
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.github.profile.get({ handle: "torvalds" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
const params = new URLSearchParams({
  handle: "torvalds",
});
const res = await fetch(`https://socialtap.dev/v1/github/profile?${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);
```

Python (requests):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/github/profile",
    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"])
```

Go (net/http):

```go
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/profile?"+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"])
}
```

200 OK:

```json
{
  "data": {
    "approximate_fields": [
      "external_links"
    ],
    "avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
    "banner_url": null,
    "bio": null,
    "category": null,
    "country_code": null,
    "created_at": "2011-09-03T15:26:22Z",
    "display_name": "Linus Torvalds",
    "external_links": [],
    "id": "1024025",
    "is_private": false,
    "is_verified": null,
    "location": "Portland, OR",
    "metrics": {
      "follower_count": 331755,
      "following_count": 0,
      "post_count": null,
      "total_like_count": null,
      "total_view_count": null
    },
    "platform": "github",
    "platform_specific": {
      "github": {
        "account_type": "user",
        "archived_at": null,
        "company": "Linux Foundation",
        "contribution_count": null,
        "email": null,
        "is_hireable": false,
        "is_site_admin": false,
        "node_id": "MDQ6VXNlcjEwMjQwMjU=",
        "popular_repository": null,
        "public_gist_count": 1,
        "public_repo_count": 12,
        "twitter_username": null,
        "updated_at": "2026-11-01T20:12:14Z"
      }
    },
    "type": "person",
    "unknown_fields": [],
    "url": "https://github.com/torvalds",
    "username": "torvalds"
  },
  "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": "1024025",
      "url": "https://github.com/torvalds"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

> [!NOTE]
>
> **Good to know**
>
> - id is the account's numeric ID, which stays the same after a rename. Send it as handle to read the account whatever its username is now. A username made only of digits needs an @ before it.
> - is_verified is the verified-domain badge of an organization. GitHub gives users no badge, so it is null for them.
> - external_links has the website and X account. A profile's other social accounts are included only when it is read from its page; otherwise external_links is listed in approximate_fields.
> - A bot is read by its login (dependabot\[bot\], Copilot), its account ID or its app's link (github.com/apps/dependabot), and its url is that app's page.
> - If GitHub's API refuses, the account is read from its public page. The follower counts are then rounded and listed in approximate_fields, and the join date, gist count and node ID are null.

## Authorizations

`x-api-key`stringheaderrequired

Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `handle` required | `string`<br>max 2,048 chars | The GitHub account: its username (login), with or without the @; its numeric account ID, which every answer gives as id and which survives a rename; or its link (github.com/torvalds, with any tab, github.com/orgs/github, a bot's github.com/apps/dependabot, gist.github.com/\<username>, api.github.com/users/\<username>). | `torvalds` |

`handle` takes GitHub profile links; another kind of link, or another platform's, fails free with [`invalid_input`](https://socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)).

**Parameters every endpoint accepts**

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>min 0 | 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. | — |
| `fields` optional | `string` | Return 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 [profile](https://socialtap.dev/resources/profile/index.md) object; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only GitHub has are under `platform_specific.github`.

| Field | Type | Description |
| --- | --- | --- |
| `data.platform` | `string` | Platform ID (tiktok, youtube, …). |
| `data.id` | `string` | Platform-native account ID (string; YouTube UC…, Reddit t2_…). |
| `data.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.display_name` | `string` or `null` | Display name, channel title or page name; null when empty or not exposed. |
| `data.url` | `string` (uri) | Canonical profile URL. |
| `data.type` | `string` | Coarse 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.<br>One of `person`, `organization`, `community`, `unknown` |
| `data.bio` | `string` or `null` | Profile bio, channel description or page about text; null when empty or not exposed. |
| `data.avatar_url` | `string` (uri) or `null` | Profile picture URL (largest available). Platform CDN URLs can expire within hours. |
| `data.banner_url` | `string` (uri) or `null` | Header or cover image URL. |
| `data.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.is_private` | `boolean` or `null` | True when the account's posts are not public. |
| `data.category` | `string` or `null` | Platform category label (e.g. Musician, Media & Entertainment), as shown; not normalized. Often set only for business or creator accounts. |
| `data.external_links` | `object[]` | Links in the bio or channel links; \[\] if none or not exposed. |
| `data.external_links[].url` | `string` (uri) | Link target, absolute (https:// is added where the platform stores the link without a scheme). |
| `data.external_links[].title` | `string` or `null` | Link label shown by the platform. |
| `data.location` | `string` or `null` | Self-declared location text. |
| `data.country_code` | `string` or `null` | ISO 3166-1 alpha-2 country the platform states for the account. |
| `data.created_at` | `string` (date-time) or `null` | Account creation or join date, RFC 3339 UTC (some platforms give only the day: see approximate_fields). |
| `data.metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
| `data.metrics.follower_count` | `integer` or `null` | Followers or subscribers. |
| `data.metrics.following_count` | `integer` or `null` | Accounts this profile follows. |
| `data.metrics.post_count` | `integer` or `null` | Posts or videos as the platform counts them on the profile (for a private account, posts the caller cannot see). |
| `data.metrics.total_like_count` | `integer` or `null` | Likes received across all of the profile's posts (not likes given). |
| `data.metrics.total_view_count` | `integer` or `null` | Lifetime views across all of the profile's posts. |
| `data.platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |
| `data.platform_specific.github` | `object` or `null` | A GitHub user's, organization's or bot's own fields. |
| `data.platform_specific.github.node_id` | `string` or `null` | The account's global node ID, as GitHub's GraphQL API keys it (MDQ6VXNlcjEwMjQwMjU=); null when the profile page answered instead of the API. |
| `data.platform_specific.github.account_type` | `string` or `null` | What 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.<br>One of `user`, `organization`, `bot` |
| `data.platform_specific.github.company` | `string` or `null` | The company the account names on its profile, as written (an @mention of an organization included); null when it names none. |
| `data.platform_specific.github.email` | `string` or `null` | The email address the account chose to show on its profile; null when it shows none. |
| `data.platform_specific.github.twitter_username` | `string` or `null` | The X (Twitter) username the account links, without the @; null when it links none. |
| `data.platform_specific.github.public_repo_count` | `integer` or `null` | How many public repositories the account owns. |
| `data.platform_specific.github.public_gist_count` | `integer` or `null` | How many public gists the account owns; null when the profile page answered instead of the API. |
| `data.platform_specific.github.is_site_admin` | `boolean` or `null` | True for GitHub staff accounts; null when the profile page answered instead of the API. |
| `data.platform_specific.github.is_hireable` | `boolean` or `null` | True when the user marked itself available for hire; null on an organization or bot, or when the profile page answered instead of the API. |
| `data.platform_specific.github.updated_at` | `string` (date-time) or `null` | When the account's profile last changed, RFC 3339 UTC; null when the profile page answered instead of the API. |
| `data.platform_specific.github.archived_at` | `string` (date-time) or `null` | When the organization was archived (read-only), RFC 3339 UTC; null when it is not archived, and on a user or bot. |
| `data.platform_specific.github.contribution_count` | `integer` or `null` | How 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. |
| `data.platform_specific.github.popular_repository` | `object` or `null` | The 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. |
| `data.platform_specific.github.popular_repository.id` | `string` or `null` | GitHub's numeric repository ID, as Repository.id; null when the board's row doesn't name it. |
| `data.platform_specific.github.popular_repository.full_name` | `string` | Owner and name as in its link (torvalds/linux); the owner can be an organization rather than the developer. |
| `data.platform_specific.github.popular_repository.name` | `string` | The repository's name without its owner (linux), as its link spells it. |
| `data.platform_specific.github.popular_repository.url` | `string` (uri) | Canonical repository page URL. |
| `data.platform_specific.github.popular_repository.owner` | `object` | The account that owns it, as Repository.owner: the developer, or an organization (then only its username and url are known). |
| `data.platform_specific.github.popular_repository.owner.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data.platform_specific.github.popular_repository.owner.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.platform_specific.github.popular_repository.owner.display_name` | `string` or `null` | Display name shown on the profile. |
| `data.platform_specific.github.popular_repository.owner.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data.platform_specific.github.popular_repository.owner.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data.platform_specific.github.popular_repository.owner.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.platform_specific.github.popular_repository.description` | `string` or `null` | The 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. |
| `data.approximate_fields` | `string[]` | 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. |
| `data.unknown_fields` | `string[]` | 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: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | The 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_reached` | 402 | No | The 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The 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](mailto:support@socialtap.dev). 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. |
| `private_or_unavailable` | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. |

### 404

404 Not Found: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | The 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The 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](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

### 451

451: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unavailable_for_legal_reasons` | 451 | No | We removed this item after a copyright notice or another legal request, so we don't return it. The request was free. A list leaves such items out instead, with an items_omitted warning. | Do not retry. The item stays unavailable unless the notice is withdrawn. |

### 500

500 Internal Error: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. |

### 502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_error` | 502 | Yes, later | The 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.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. |
| `overloaded` | 503 | Yes, later | SocialTap 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. |

## Pricing

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`; sources are tried cheapest first: Platform API → Public page.

| Source | Price per successful request | Per 1,000 requests |
| --- | --- | --- |
| 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`](https://socialtap.dev/docs/errors/index.md#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](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md)

Endpoint ID `github.profile` · operationId `github.profile.get` · [Product overview](https://socialtap.dev/apis/github/profile/index.md)

---

[HTML version](https://socialtap.dev/docs/reference/github/profile/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)
