Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hud0shnik/githubstatsapi
My GitHub API 🐙
https://github.com/hud0shnik/githubstatsapi
api-rest golang
Last synced: 1 day ago
JSON representation
My GitHub API 🐙
- Host: GitHub
- URL: https://github.com/hud0shnik/githubstatsapi
- Owner: hud0shnik
- License: bsd-3-clause
- Created: 2022-02-19T10:24:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T09:09:21.000Z (2 months ago)
- Last Synced: 2024-09-10T10:41:53.416Z (2 months ago)
- Topics: api-rest, golang
- Language: Go
- Homepage: githubstatsapi.vercel.app
- Size: 146 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🐙 GithubStatsAPI 📈
GithubStatsAPI provides fast access to GitHub user statistics and commits
## Overview
- [Overview](#overview)
- [Commits](#commits)
- [User](#user)
- [Repo](#repo)
- [Samples](#samples)
## Commits
### Request
``` Elixir
https://githubstatsapi.vercel.app/api/commits
```
Parameter | Value type | Required | Description
----------------|------------|----------|------------
id | string | Yes | username
date | string | No | date (like 2022-01-21)
### Structures
#### UserCommits
Field | Type | Description
----------------------------|--------------------|------------
success | bool |
error | string | api error response (default value= "")
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
``` Elixir
https://githubstatsapi.vercel.app/api/user
```
Parameter | Value type | Required | Description
----------------|------------|----------|------------
id | string | Yes | username
type | string | No | response type (like "string")
### Structures
#### UserInfo
Field | Type | Description
----------------------------|--------------------|------------
success | bool |
error | string | api error response (default value= "")
username | string |
name | string |
followers | string |
following | string |
repositories | string |
packages | string |
stars | string |
contributions | string |
status | string |
avatar | string | avatar url
## Repo
### Request
``` Elixir
https://githubstatsapi.vercel.app/api/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
----------------------------|--------------------|------------
success | bool |
error | string | api error response (default value= "")
username | string |
reponame | string |
commits | string |
branches | string |
tags | string |
stars | string |
watching | string |
forks | string |
### Samples
#### Request
``` Elixir
https://githubstatsapi.vercel.app/api/commits?id=hud0shnik&date=2023-03-05
```
#### Response
``` Json
{
"success": true,
"error": "",
"date": "2023-03-05",
"username": "hud0shnik",
"commits": 6,
"color": 3
}
```
#### Request
``` Elixir
https://githubstatsapi.vercel.app/api/user?id=hud0shnik
```
#### Response
``` Json
{
"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
``` Elixir
https://githubstatsapi.vercel.app/api/repo?username=hud0shnik&reponame=osustatsapi
```
#### Response
``` Json
{
"success": true,
"error": "",
"username": "hud0shnik",
"reponame": "osustatsapi",
"commits": 658,
"branches": 1,
"tags": 0,
"stars": 2,
"watching": 1,
"forks": 1
}
```
[](/LICENSE)