Skip to main content
GET
Get profile
This is the same operation documented at GitHub profiles. Use a login or @handle, never a profile URL. Optional sections depend on public source visibility. Client timeout examples are not latency guarantees.
  • overview accepts year only.
  • repositories accepts page only, with 30 rows per page.
  • User-only stars accepts next_page_token only, with 30 rows per page.
Every successful request costs 10 credits. Read the profile guide for calendar windows, pagination, null/omission semantics and unbilled source failures.

Authorizations

X-API-Key
string
header
required

Path Parameters

username
string
required

GitHub login or leading @handle, not a profile URL. Up to 39 login characters; reserved site routes and invalid logins are rejected.

Required string length: 1 - 40
Pattern: ^@?[A-Za-z0-9](?:[A-Za-z0-9-]{0,37}[A-Za-z0-9])?$

Query Parameters

tab
enum<string>
default:overview

Profile mode. Stars supports user accounts only.

Available options:
overview,
repositories,
stars
year
integer

Overview only: 1970 through the current UTC year; activity is December or current month

Required range: x >= 1970
page
integer

Repositories only. Positive page number; 30 repository rows per page. Follow pagination.next_page.

Required range: x >= 1
next_page_token
string

Stars only. Exact opaque pagination.next_page_token from the prior response; not a URL. 30 rows per page.

Maximum string length: 1024

Response

Unwrapped profile object. Source-specific sections may be omitted. Representative examples are abridged and not live production results.

Unwrapped profile response, with mode-specific public sections.

profile
GitHubProfile · object
required
pinned_repositories
GitHubRepository · object[] | null
readme
GitHubReadme · object | null
organizations
GitHubAccountPreview · object[] | null
sponsors
GitHubAccountPreview · object[] | null
sponsoring
GitHubAccountPreview · object[] | null
additional_sponsors_count
integer | null
additional_sponsoring_count
integer | null
achievements
GitHubAchievement · object[] | null
highlights
GitHubTextLink · object[] | null
contributions
GitHubContributions · object | null

Public user overview only; omitted for organizations and other tabs.

repositories
GitHubRepository · object[] | null
starred_repositories
GitHubRepository · object[] | null
star_lists
GitHubNamedLink · object[] | null
pagination
GitHubPagination · object | null
top_languages
GitHubLanguage · object[] | null
topics
string[] | null
people
GitHubAccountPreview · object[] | null
verified_domains
string[] | null