社交

查询 GitHub 用户信息

0次调用
2 积分/次

需要获取开发者的 GitHub 画像?这个接口不仅能返回详尽的基础资料和所属的公开组织列表,还能一键拉取开发者的绿格子数据。

GET
uapis.cn
/api/v1/github/user
查询参数
7
user
string
required

GitHub 用户名(必需符合 GitHub 命名规范:仅限字母、数字、连字符,最长 39 位)。

activity
boolean

是否获取最近一年的贡献活动数据(如贡献图、时间线)。传入 true 开启,其他值均视为不开启。

activity_scope
string

活动数据范围。可选 all 或 organization。只有开启 activity 时才有意义。

org
string

组织登录名。如果传入此参数,会自动视为开启 organization 级别的贡献查询,切勿再同时传 activity_scope=all。

pinned
boolean

是否附带该用户在 GitHub 主页展示的 pinned 仓库数据。传入 true 开启,其他值均视为不开启。

repos
boolean

是否附带该用户最近活跃的公开仓库列表。传入 true 开启,其他值均视为不开启。

repos_limit
integer

公开仓库列表的返回数量。只有开启 repos 时才有意义;如果单独传入 repos_limit,也会自动视为开启 repos。

功能概述

  • 开发者基础画像:返回用户的仓库数、关注数、公司、地理位置和社交媒体链接等,非常适合用来自动生成技术博客的作者名片或建立开发者档案。
  • 贡献日历与时间线:只要开启 activity=true,就能获取该用户最近一年的全量贡献数据。返回的 JSON 已经将数据按周(weeks)和天(days)整理好,前端通过简单的双重循环就能画出和 GitHub 主页一模一样的贡献日历。
  • 组织级贡献过滤:如果你只想评估某个人在特定团队开源项目中的活跃度,直接传入 org 参数。接口会自动剥离他在其他私有项目或个人仓库的提交,只返回针对该组织的贡献数据。

查询参数

user
string必填

GitHub 用户名(必需符合 GitHub 命名规范:仅限字母、数字、连字符,最长 39 位)。

activity
boolean可选

是否获取最近一年的贡献活动数据(如贡献图、时间线)。传入 true 开启,其他值均视为不开启。

activity_scope
string可选

活动数据范围。可选 all 或 organization。只有开启 activity 时才有意义。

org
string可选

组织登录名。如果传入此参数,会自动视为开启 organization 级别的贡献查询,切勿再同时传 activity_scope=all。

pinned
boolean可选

是否附带该用户在 GitHub 主页展示的 pinned 仓库数据。传入 true 开启,其他值均视为不开启。

repos
boolean可选

是否附带该用户最近活跃的公开仓库列表。传入 true 开启,其他值均视为不开启。

repos_limit
integer可选

公开仓库列表的返回数量。只有开启 repos 时才有意义;如果单独传入 repos_limit,也会自动视为开启 repos。

响应

200 / 请求成功

成功获取用户信息。如果开启了 activity=true,会在响应体中附加 activity 对象。

JSON
{
  // GitHub 登录名。
  "login": "torvalds",
  // 用户公开显示的名称。
  "name": "Linus Torvalds",
  // 用户个人简介。
  "bio": "Linux kernel creator",
  // 用户填写的公司或组织信息。
  "company": "Linux Foundation",
  // 用户公开展示的地理位置。
  "location": "Portland, OR",
  // 用户填写的网站或博客地址。
  "blog": "",
  // 用户绑定的 X(Twitter)用户名。
  "twitter_username": "",
  // 用户公开可见的邮箱地址。
  "email": "",
  // GitHub 个人主页链接。
  "html_url": "https://github.com/torvalds",
  // 用户头像图片链接。
  "avatar_url": "https://avatars.githubusercontent.com/u/1024025?v=4",
  // 账号类型,常见值为 User 或 Organization。
  "type": "User",
  // 公开仓库数量。
  "public_repos": 8,
  // 公开 Gist 数量。
  "public_gists": 0,
  // 关注该用户的人数。
  "followers": 100,
  // 该用户正在关注的人数。
  "following": 0,
  // GitHub 账号创建时间(ISO 8601)。
  "created_at": "2011-09-03T15:26:22Z",
  // 用户资料最近更新时间(ISO 8601)。
  "updated_at": "2026-04-12T00:00:00Z",
  // 用户公开加入的组织列表
  "organizations": [
    {
      // 组织登录名。
      "login": "linux-foundation",
      // 组织简介。
      "description": "Open source organization",
      // 组织主页链接。
      "html_url": "https://github.com/linux-foundation",
      // 组织头像链接。
      "avatar_url": "https://avatars.githubusercontent.com/u/123456?v=4"
    }
  ],
  // 用户主页展示的 pinned 仓库列表(需开启 pinned=true)。
  "pinned_repositories": [
    {
      // 仓库名。
      "name": "linux",
      // 包含所有者的完整仓库名。
      "full_name": "torvalds/linux",
      // 仓库简介。
      "description": "Linux kernel source tree",
      // 仓库主页链接。
      "html_url": "https://github.com/torvalds/linux",
      // 仓库填写的官网地址。
      "homepage": "https://www.kernel.org",
      // 仓库主语言。
      "language": "C",
      // 仓库可见性。
      "visibility": "PUBLIC",
      // Star 数量。
      "stargazers": 200000,
      // Fork 数量。
      "forks": 55000,
      // 该仓库是否为 fork。
      "fork": false,
      // 该仓库是否已归档。
      "archived": false,
      // 最近一次 push 时间。
      "pushed_at": "2026-04-15T00:00:00Z",
      // 最近一次资料更新时间。
      "updated_at": "2026-04-15T00:00:00Z"
    }
  ],
  // 最近活跃的公开仓库列表(需开启 repos=true 或传入 repos_limit)。
  "repositories": [
    {
      // 仓库名。
      "name": "linux",
      // 包含所有者的完整仓库名。
      "full_name": "torvalds/linux",
      // 仓库简介。
      "description": "Linux kernel source tree",
      // 仓库主页链接。
      "html_url": "https://github.com/torvalds/linux",
      // 仓库填写的官网地址。
      "homepage": "https://www.kernel.org",
      // 仓库主语言。
      "language": "C",
      // 仓库可见性。
      "visibility": "public",
      // Star 数量。
      "stargazers": 200000,
      // Fork 数量。
      "forks": 55000,
      // 该仓库是否为 fork。
      "fork": false,
      // 该仓库是否已归档。
      "archived": false,
      // 最近一次 push 时间。
      "pushed_at": "2026-04-15T00:00:00Z",
      // 最近一次资料更新时间。
      "updated_at": "2026-04-15T00:00:00Z"
    }
  ],
  // 贡献活动数据(需开启 activity=true)
  "activity": {
    // 活动统计范围,常见值为 all 或 organization。
    "scope": "organization",
    // 按组织过滤时对应的组织登录名。
    "organization": "linux-foundation",
    // 统计开始日期。
    "from": "2025-04-12",
    // 统计结束日期。
    "to": "2026-04-12",
    // 统计范围内的总贡献数。
    "total_contributions": 4,
    // Commit 贡献总数。
    "total_commit_contributions": 2,
    // Issue 贡献总数。
    "total_issue_contributions": 1,
    // Pull Request 贡献总数。
    "total_pull_request_contributions": 1,
    // Pull Request Review 贡献总数。
    "total_pull_request_review_contributions": 0,
    // 按周整理好的贡献日历数据。
    "contribution_calendar": {
      // 贡献等级对应的颜色列表。
      "colors": [
        "string"
      ],
      // 是否启用了 GitHub 万圣节配色主题。
      "is_halloween": false,
      // 贡献日历中的总贡献数。
      "total_contributions": 4,
      // 按周排列的贡献日历列数据。
      "weeks": [
        {
          // 这一周的第一天日期。
          "first_day": "2026-04-06",
          // 这一周中每天的贡献明细。
          "contribution_days": [
            {
              // 当天日期。
              "date": "2026-04-07",
              // 当天的贡献次数。
              "contribution_count": 1,
              // 当天贡献等级对应的颜色值。
              "color": "#40c463",
              // 星期索引,0 表示周日,6 表示周六。
              "weekday": 2
            }
          ]
        }
      ]
    },
    // 按月份聚合后的贡献时间线。
    "timeline": [
      {
        // 月份,格式为 YYYY-MM。
        "month": "2026-04",
        // 该月的贡献总数。
        "contribution_count": 4
      }
    ]
  }
}

400 / 错误的请求

参数格式错误,或参数组合不合法。

格式 1参数组合冲突
JSON
{
  // 错误码。
  "code": "INVALID_PARAMETER",
  // 错误原因说明。
  "error": "传了 org 时,activity_scope 只能传 organization"
}
格式 2非法的作用域
JSON
{
  // 错误码。
  "code": "INVALID_PARAMETER",
  // 错误原因说明。
  "error": "activity_scope 只能传 all 或 organization"
}

404 / 未找到

找不到指定的用户,或者传入的组织不存在。

JSON
{
  // 错误码。
  "code": "USER_NOT_FOUND",
  // 错误原因说明。
  "error": "未找到对应的 GitHub 用户"
}

502 / 网关错误

上游服务器发生错误或响应超时。

JSON
{
  // 错误码。
  "code": "UPSTREAM_ERROR",
  // 错误原因说明。
  "error": "请求 GitHub 上游接口失败"
}