Public users & organizations
Turn a GitHub handle into a structured profile: README, pinned repositories, contribution history and public organization details.
10 credits per request · Same price for every tab · No GitHub token required
{
"profile": {
"login": "example-user",
"name": "Example Developer",
"is_organization": false
},
"pinned_repositories": [
{
"position": 1,
"name": "example-project",
"full_name": "example-user/example-project",
"language": "TypeScript"
}
],
"readme": {
"text": "Building open-source tools.",
"link": "https://github.com/example-user/example-user"
},
"contributions": {
"calendar": [
{
"date": "2026-01-01",
"count": 3,
"level": 1
}
]
}
}Illustrative response excerpt. Fields vary by account and selected tab.
GET /v1/github/profiles/{username} — use a login or @handle. GitHub profiles are global, with no market selector.
tab=overviewPublic user or organization profile, README and pinned or popular repositories. User overviews also include contributions; organization overviews omit user-only activity.
Overview only: 1970 through the current year. Omit for the last 12 months; set a year for its calendar. User contribution activity only.
tab=repositoriesPublic repository summaries on a user or organization profile. Pages contain up to 30 rows; follow pagination.next_page while has_next is true.
Repository tab only: a positive page number, starting at 1.
tab=starsStarred repository summaries and star lists for public user accounts. Organization stars are unsupported and return 400. Follow pagination.next_page_token while has_next is true.
Stars only: copy the opaque next_page_token from the previous response. Omit for the first page; do not enter a URL.
Names, bio, links, social accounts and profile counts in structured JSON. Metadata includes creation and update dates when available.
Keep GitHub’s distinction between repositories someone pinned and the popular repositories shown in their place.
Read the profile introduction as text and rendered HTML, with a link to its source repository. Profiles without a displayed README do not invent one.
Retrieve dated user contribution counts and activity, or select a calendar year. Organization profiles omit user-only activity.
Page through profile repository summaries and user stars. Follow the next page or opaque token returned with the response.
Read the organization’s public README, repositories, languages, topics and people previews when displayed on its profile.
Estimate your GitHub profile requests using the endpoint price and available credit plans.
Every tab uses the same per-request price. Check the live pricing catalog before planning usage.
Use standard HTTP with your ScrapeBadger API key. Choose overview, repositories or stars with the tab parameter.
Repository pages and stars cursors are separate pagination modes. The reference documents which fields apply to users and organizations.
const username = 'yyx990803';
const url = new URL(
'/v1/github/profiles/' + encodeURIComponent(username),
'https://scrapebadger.com',
);
url.searchParams.set('tab', 'overview');
const response = await fetch(url, {
headers: { 'X-API-Key': process.env.SCRAPEBADGER_API_KEY ?? '' },
});
if (!response.ok) throw new Error('HTTP ' + response.status);
const profile = await response.json();
console.log(profile);No. Use your ScrapeBadger API key to request public profiles. You do not need to connect a GitHub account.
Yes. Overview and repositories support users and organizations. Organizations have their own public profile fields and no user contribution calendar. The stars tab supports user accounts only.
On the overview tab, set year to a value from 1970 through the current year for that calendar year. Without year, the calendar covers the last 12 months. Activity uses December for past years and the current month for the current year.
Use page, starting at 1, with tab=repositories. For tab=stars, pass the returned pagination.next_page_token to the next request. Both tabs return up to 30 repository summaries per page.
Each profile tab uses the same per-request credit price. The estimator reads the public pricing catalog; the dashboard response shows the credits used. Failed requests do not consume credits.
Choose a profile tab and try its parameters in the playground.
Open playgroundScrapeBadger is an independent tool and is not affiliated with, endorsed by, or sponsored by GitHub, Inc. GitHub is a trademark of GitHub, Inc., used only to describe the platform this API works with.