GitHub · Guide

How to get GitHub user

TL;DR

To get GitHub user, sign up for a free Captapi key, then send one GET request to /v1/github/user with your input. You get clean JSON back in seconds for 3 credits per call — no OAuth, scraping or platform SDKs. Fetch GitHub user — display name, bio, counts, and verification as structured JSON.

Get your free API key API reference

How to get GitHub user (step by step)

1
Get a free API key
Create a free Captapi account (100 credits, no card) and generate an API key from the dashboard.
2
Call the GitHub User API
Send an authenticated GET request to /v1/github/user with your input. No OAuth, no scraping setup.
3
Read the JSON response
Parse the clean JSON response. Pass cache=true for a free 24h cache hit; default is always fresh.

Code example

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

What the response looks like

{
  "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 (credits charged, cache hit/miss) is returned in the X-Captapi-Credits and X-Captapi-Cache response headers.

Request 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.

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.

Ready to get GitHub user?

Start free with 100 credits — no credit card required.

Get your free API key