Categorygithub.com/hud0shnik/githubstatsapi
module
0.0.0-20240909090913-463067f1665d
Repository: https://github.com/hud0shnik/githubstatsapi.git
Documentation: pkg.go.dev

# README

🐙 GithubStatsAPI 📈

GithubStatsAPI provides fast access to GitHub user statistics and commits

Overview

Commits

Request

https://githubstatsapi.vercel.app/api/commits
ParameterValue typeRequiredDescription
idstringYesusername
datestringNodate (like 2022-01-21)

Structures

UserCommits

FieldTypeDescription
successbool
errorstringapi error response (default value= "")
datestringdate (like 2022-01-21)
usernamestring
commitsint
colorint

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/user
ParameterValue typeRequiredDescription
idstringYesusername
typestringNoresponse type (like "string")

Structures

UserInfo

FieldTypeDescription
successbool
errorstringapi error response (default value= "")
usernamestring
namestring
followersstring
followingstring
repositoriesstring
packagesstring
starsstring
contributionsstring
statusstring
avatarstringavatar url

Repo

Request

https://githubstatsapi.vercel.app/api/repo
ParameterValue typeRequiredDescription
usernamestringYesusername
reponamestringYesreponame
typestringNoresponse type (like "string")

Structures

RepoInfo

FieldTypeDescription
successbool
errorstringapi error response (default value= "")
usernamestring
reponamestring
commitsstring
branchesstring
tagsstring
starsstring
watchingstring
forksstring

Samples

Request

https://githubstatsapi.vercel.app/api/commits?id=hud0shnik&date=2023-03-05

Response

{
  "success": true,
  "error": "",
  "date": "2023-03-05",
  "username": "hud0shnik",
  "commits": 6,
  "color": 3
}

Request

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

Response

{
  "success": true,
  "error": "",
  "username": "hud0shnik",
  "name": "Danila Egorov",
  "followers": 61,
  "following": 0,
  "repositories": 29,
  "packages": 0,
  "stars": 7,
  "contributions": 0,
  "status": "Drawin'",
  "avatar": "https://avatars.githubusercontent.com/u/42404892?v=4"
}

Request

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

Response

{
  "success": true,
  "error": "",
  "username": "hud0shnik",
  "reponame": "osustatsapi",
  "commits": 658,
  "branches": 1,
  "tags": 0,
  "stars": 2,
  "watching": 1,
  "forks": 1
}

License - BSD 3-Clause

# Packages

No description provided by the author