Skip to content

GitHub API

Andrei Tcibin edited this page Apr 9, 2019 · 1 revision

APIs

GitHub two versions of the API:

GraphQL API is a preferred one to use as long as it provides more concise API rather then REST. It may reduce profiles parsing time significantly.

Data

The following tables include brief descriptions of some valuable data that can be collected for a specific GitHub profile.

User

Data Source Description
Login User.login User login.
Nickname User.name User account name.
Organization User.company Organization user works for or a company hashtag.
City User.location City user lives in.
Email User.email User email.
Website User.websiteUrl User personal website.
Biography User.bio User biography.
Avatar User.avatarUrl User avatar url.
Hiring status User.isHireable Specifies if user is open for hiring or not.
Followers User.followers A list of users that follows the user.
Following User.following A list of users the user follows.
Starred repositories User.starredRepositories A list of repositories the user starred.
Registration date User.createdAt User registration date.
Repositories User.repositories A list of repositories that user owns.
Organizations User.organizations A list of organizations that user belongs to.

Repository

Data Source Description
Name Repository.name Repository name.
Tags Repository.labels Repository tags.
Language Repository.primaryLanguage Repository primary language.
Languages Repository.languages Repository languages.
Description Repository.description Repository description.
Creation date Repository.createdAt Repository creation date.
Website Repository.homepageUrl Repository website.
License Repository.licenseInfo Repository licence.
Fork status Repository.isFork Specifies if the repository is a fork or not.
Forked repositories Repository.forks Repositories that are forked from the repository.
Parent Repository.parent Parent repository if this is a fork repository.
Updated date Repository.pushedAt Repository latest updated date.
Clone this wiki locally