Social

Query GitHub User

0calls

2 credits / call

Need a complete picture of a developer's GitHub presence? This endpoint returns a detailed basic profile, the list of organizations the developer belongs to, and can also pull the developer's contribution-square data in a single call.

Overview

Basic developer profile: Returns repository count, follower count, public email, location, social-media links, and other profile fields. Useful for auto-generating developer cards on technical blogs or building developer dossiers.
Contribution calendar and timeline: When activity=true is enabled, the endpoint fetches the user's full contribution data for the past year. The returned JSON is pre-aggregated by week (weeks) and day (days), so a simple double-loop on the frontend renders the same calendar shown on the user's GitHub profile.
Organization-scoped contributions: To evaluate someone's activity inside a specific team or open-source project only, pass the org parameter. The endpoint strips out commits made to private projects or personal repositories outside the organization and returns contributions scoped to that organization.

Query parameters

user

stringrequired

GitHub username. Must follow GitHub naming rules (alphanumerics and hyphens, up to 39 characters).

activity

booleanoptional

Whether to fetch the last year's contribution activity (e.g. contribution counts, dates). Pass true to enable; any other value disables it.

activity_scope

stringoptional

Contribution-activity scope. Allowed values: all or organization. Only meaningful when activity is enabled.

org

stringoptional

Organization login name. When provided, the endpoint automatically switches to organization-scoped contribution queries (sets activity_scope=organization).

pinned

booleanoptional

Whether to also return the user's pinned repositories. Pass true to enable; any other value disables it.

repos

booleanoptional

Whether to also return the user's recently active public repositories. Pass true to enable; any other value disables it.

repos_limit

integeroptional

Maximum number of public repositories to include. Only meaningful when repos=true. Passing repos_limit alone is treated as repos=true.

Name	Type	Attributes	Description
`user`	string	required	GitHub username. Must follow GitHub naming rules (alphanumerics and hyphens, up to 39 characters).
`activity`	boolean	optional	Whether to fetch the last year's contribution activity (e.g. contribution counts, dates). Pass `true` to enable; any other value disables it.
`activity_scope`	string	optional	Contribution-activity scope. Allowed values: `all` or `organization`. Only meaningful when `activity` is enabled.
`org`	string	optional	Organization login name. When provided, the endpoint automatically switches to organization-scoped contribution queries (sets `activity_scope=organization`).
`pinned`	boolean	optional	Whether to also return the user's pinned repositories. Pass `true` to enable; any other value disables it.
`repos`	boolean	optional	Whether to also return the user's recently active public repositories. Pass `true` to enable; any other value disables it.
`repos_limit`	integer	optional	Maximum number of public repositories to include. Only meaningful when `repos=true`. Passing `repos_limit` alone is treated as `repos=true`.

Response

200 / OK

Success. Returns the user's information. When activity=true is set, an activity object is included in the response.

JSON

400 / Bad Request

Invalid parameter format or invalid parameter combination.

Format 1Conflicting parameter combination.

JSON

Format 2Invalid username.

JSON

404 / Not Found

Specified user not found, or the provided organization does not exist.

JSON

502 / Bad Gateway

Upstream server error or response timeout.

JSON

Quick start

Pick your language to see usage examples

Auth mode:

cURL command

curl 'https://uapis.cn/api/v1/github/user?user=torvalds'

Frequently asked questions

Once the frontend has the `contribution_calendar` data, how do I render the contribution graph?

The `contribution_calendar.weeks` field returned by the endpoint is an array of weeks, each containing per-day `color` and `contribution_count` values. On the frontend, use a two-level loop — the outer loop iterates `weeks` to render columns, and the inner loop iterates `contribution_days` to render squares — and assign each square's `background-color` to the supplied `color`. That reproduces the GitHub-style contribution calendar.

Why are some of my account's contributions missing on the public profile?

This is most likely caused by your GitHub privacy settings. By default, GitHub hides contributions from private repositories. Only commits, PRs, and issues from public projects appear in the data when private contributions are not shared publicly.

PreviousQuery GitHub Repository

NextCategory overview