Optional fields depend on public source visibility. Examples illustrate the request
contract; client timeout settings are not endpoint latency guarantees.
GET https://scrapebadger.com/v1/github/profiles/{username}.
Use a login or @handle, not a profile URL. Accounts are global, so you do not
need a market or language parameter. Authenticate with your ScrapeBadger
X-API-Key; no GitHub access token is required.
Choose a profile tab
year is overview-only, page repositories-only, and next_page_token stars-only.
Organizations do not have the user stars mode or user contribution calendar.
Every successful page costs 10 credits. Use X-Credits-Used to check
the actual charge. Your plan determines the currency
price of credits; check credits and pricing.
Representative request
year, the calendar covers that whole year and the activity timeline
covers December. For the current year the timeline covers the current month.
Without year, the calendar covers the last 12 months and the timeline the
current month. These windows are reported separately.
Understand the response
The root object containsprofile and the sections available for the requested
account and tab. User overview can contain pinned_repositories or
popular_repositories, readme, organizations, achievements, highlights,
sponsors, sponsoring, and contributions. Organization overview can include
repositories, people, top_languages, topics, and verified_domains.
The profile endpoint reference defines the full field schema.
Counts from supplemental public metadata are exact where available. The original
website counts remain in followers_display_count and following_display_count.
Compact website counts that remain estimates have a *_approximate flag. Dates
have ISO *_at and Unix-seconds *_utc fields where the source provides a timestamp.
An omitted section is unavailable or not applicable; it is not proof of zero
activity. An explicitly published null metadata value remains null. Empty lists
require a recognized public empty state. A blocked or failed contribution read
returns an unbilled error rather than an empty calendar.
Integrations
Representative CLI commands:github_get_profile(username, tab?, year?, page?, next_page_token?) through
MCP. Add ?apis=github to list the tool directly, or use the
free discovery helpers. SDK namespaces are generated from the API contract;
release verification is required before relying on a published SDK version.
The profile endpoint covers public profiles; repository detail has its own endpoint
below. General GitHub search, trending, private repositories and member-only
organization views are not part of this API.
Public repository detail
UseGET /v1/github/repositories/{owner}/{repo} for a public repository’s
default-branch statistics, topics, license, native README, root files and latest
commit. Pass owner.login and name from a profile repository summary.
Repository detail has no market, ref or pagination parameter. Each successful
response costs 10 credits; health and failed requests cost zero.
Representative integrations: scrapebadger github repository cli cli and
github_get_repository(owner="cli", repo="cli") through MCP.
See repository parameters and fields.

