社交

查询 GitHub 用户信息

0次调用
2 积分/次

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

功能概述

  • 开发者基础画像:返回用户的仓库数、关注数、公司、地理位置和社交媒体链接等,非常适合用来自动生成技术博客的作者名片或建立开发者档案。
  • 贡献日历与时间线:只要开启 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

400 / 错误的请求

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

格式 1参数组合冲突
JSON
格式 2非法的作用域
JSON

404 / 未找到

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

JSON

502 / 网关错误

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

JSON