GitHub

GET /v1/github/user

GitHub User API

Fetch GitHub user — display name, bio, counts, and verification as structured JSON.

3 credits per request

Try in Playground Get your API key — free Read the docs

TL;DR

Fetch GitHub user — display name, bio, counts, and verification as structured JSON. The GitHub User API (GitHub) is a single authenticated GET request to /v1/github/user that responds with clean JSON and costs 3 credits. Pass cache=true for a free 24h cache hit; default is always fresh. Start with 100 free credits — no credit card.

What is the GitHub User API?

The GitHub User API lets you fetch profile or page details and audience stats for GitHub user with a single REST call. No OAuth, no infrastructure to maintain, and no platform SDKs — send the request, get clean structured JSON back. Pass cache=true to serve from the 24h shared cache (0 credits on hit); default is always fresh.

What you get

Display name, handle or URL, bio, and avatar when available
Follower / subscriber and content counts
Verification status and external links when exposed
Structured JSON ready for enrichment and dashboards

Try it

Open in Playground

Fill in the parameters below and copy a ready-to-run request, or open the live Playground to run it against your account (no API key paste).

Parameters

username*stringGitHub username or profile URL, e.g. vercel or https://github.com/vercel.cacheoptionalbooleanSet true to serve from the 24h response cache. Default false — always fetch fresh data.

API keyoptionalPaste your key to get a ready-to-run snippet. It stays in your browser.Sign in to run live

curl "https://api.captapi.com/v1/github/user?username=vercel" \
  -H "Authorization: Bearer capt_live_..."
# or: -H "x-api-key: capt_live_..."

Edit the parameters and the code updates instantly. Switch languages and hit copy.

Example response

{
  "success": true,
  "data": {
    "platform": "github",
    "type": "user",
    "login": "sindresorhus",
    "id": 170270,
    "url": "https://github.com/sindresorhus",
    "name": "Sindre Sorhus",
    "company": null,
    "blog": "https://sindresorhus.com/apps",
    "location": null,
    "bio": "Full-Time Open-Sourcerer. Focused on Swift & JavaScript. Makes macOS apps, CLI tools, npm packages.",
    "avatar": "https://avatars.githubusercontent.com/u/170270?v=4",
    "publicRepos": 1140,
    "publicGists": 99,
    "followers": 80497,
    "following": 31,
    "twitterUsername": "sindresorhus",
    "createdAt": "2009-12-20T22:57:02Z",
    "updatedAt": "2026-06-19T19:20:46Z"
  }
}

Billing metadata is returned in response headers: X-Captapi-Credits (credits charged), X-Captapi-Cache (hit or miss), and X-Captapi-Source. Failed requests (4xx/5xx) are never charged. See the full list of error codes in the error reference.

Response structure

A successful call returns success, cached, creditsUsed, and a data object with the following fields:

Top-level fields

platformPlatform identifier (e.g. youtube, instagram).
typeContent type of the item.
loginAccount login name.
idStable platform ID for the item.
urlCanonical URL of the item.
nameName of the item or account.
companyCompany.
blogBlog URL.
locationLocation shown on the profile or item.
bioProfile bio or description.
avatarAvatar image URL.
publicReposNumber of public repositories.
publicGistsNumber of public gists.
followersFollower count.
followingNumber of accounts followed.
twitterUsernameTwitter username. Example: "sindresorhus".
createdAtCreation date (ISO 8601).
updatedAtLast update date (ISO 8601).

Parameters

Name	Type	Required	Description
username	string	Yes	GitHub username or profile URL, e.g. vercel or https://github.com/vercel.
cache	boolean	No	Set true to serve from the 24h response cache. Default false — always fetch fresh data.

Authentication: send your key as Authorization: Bearer capt_live_.... A typical call costs 3 credits. Pass cache=true for a free 24h cache hit; default is always fresh.

Using an AI agent? This endpoint is the MCP tool github_user via @captapi/mcp. Set it up →

How it works

1. Sign up — get 100 free credits, no card required.
2. Create a key from your dashboard.
3. Send one request to /v1/github/user and parse the JSON response.

Use cases

Influencer Discovery

Find and vet creators by audience size.

CRM Enrichment

Add social stats to your contact profiles.

Competitive Analysis

Track follower growth and posting cadence.

Outreach

Qualify partnership and sponsorship targets.

Frequently asked questions

What does the GitHub User API do?+

The GitHub User API lets you fetch profile or page details and audience stats from a public GitHub profile or page using one GET request to /v1/github/user. It returns clean JSON — no OAuth or infrastructure setup required.

How many credits does the GitHub User API cost?+

Each successful call costs 3 credits. Pass cache=true to serve from the 24h shared cache (0 credits on hit); default is always fresh. Failed or empty results are never charged.

Do I need a GitHub API key or OAuth?+

No. A single Captapi key works across every platform Captapi supports — YouTube, TikTok, Instagram, Facebook, Twitter/X, Reddit, Threads, Bluesky, Pinterest, LinkedIn, Rumble, Spotify, Kwai, and more. We handle proxies, rate limits, retries, and authentication for you.

Is the GitHub User API suitable for production use?+

Yes. It is a stable REST endpoint with predictable JSON and automatic retries. Pass cache=true to serve from the 24h shared cache (0 credits on hit); default is always fresh. Use it for analytics, monitoring, and content automation.

More GitHub APIs

GitHub Repositories API GitHub Pull Requests API GitHub Activity API GitHub Followers API GitHub Following API GitHub Contributions API GitHub Repository API GitHub Trending Repositories API GitHub Trending Developers API

Ready to use the GitHub User API?

Get started free