🐙 GithubStatsAPI v2 📈

Overview

• Overview
• Difference between v1 and v2
• Commits
• User
• Repo
• Samples

Difference

Version 2 use special structure for errors

apiError

Field	Type	Description
success	bool	always "false" for errors
error	string

Version 2 has new structures (without "success" and "error") and HTTP response status codes (200, 404, 500 and 400)

Commits

Request

https://githubstatsapi.vercel.app/api/v2/commits

Parameter	Value type	Required	Description
id	string	Yes	username
date	string	No	date (like 2022-01-21)

Structures

UserCommits

Field	Type	Description
date	string	date (like 2022-01-21)
username	string
commits	int
color	int

color is color of the cell. There are 5 colors in total: from gray (0) to bright green (4)

User

Request

https://githubstatsapi.vercel.app/api/v2/user

Parameter	Value type	Required	Description
id	string	Yes	username
type	string	No	response type (like "string")

Structures

UserInfo

Field	Type	Description
username	string
name	string
followers	string
following	string
repositories	string
packages	string
stars	string
contributions	string
status	string
avatar	string	avatar url

Repo

Request

https://githubstatsapi.vercel.app/api/v2/repo

Parameter	Value type	Required	Description
username	string	Yes	username
reponame	string	Yes	reponame
type	string	No	response type (like "string")

Structures

RepoInfo

Field	Type	Description
username	string
reponame	string
commits	string
branches	string
tags	string
stars	string
watching	string
forks	string

Samples

Request

https://githubstatsapi.vercel.app/api/v2/commits?id=hud0shnik&date=2023-04-28

Response

{
  "date": "2023-04-28",
  "username": "hud0shnik",
  "commits": 8,
  "color": 4
}

Request

https://githubstatsapi.vercel.app/api/v2/user?id=hud0shnik

Response

{
  "username": "hud0shnik",
  "name": "Danila Egorov",
  "followers": 62,
  "following": 0,
  "repositories": 31,
  "packages": 0,
  "stars": 9,
  "contributions": 0,
  "status": "Drawin'",
  "avatar": "https://avatars.githubusercontent.com/u/42404892?v=4"
}

Request

https://githubstatsapi.vercel.app/api/v2/repo?username=hud0shnik&reponame=osustatsapi

Response

{
  "username": "hud0shnik",
  "reponame": "osustatsapi",
  "commits": 690,
  "branches": 1,
  "tags": 0,
  "stars": 2,
  "watching": 1,
  "forks": 1
}