https://github.com/pujux/badge-it
An API serving useful badges for your GitHub Profile README 🚀🎉 Formerly known as git-badges.
https://github.com/pujux/badge-it
badges documentation github-readme readme
Last synced: 2 months ago
JSON representation
An API serving useful badges for your GitHub Profile README 🚀🎉 Formerly known as git-badges.
- Host: GitHub
- URL: https://github.com/pujux/badge-it
- Owner: pujux
- License: bsd-3-clause
- Created: 2020-07-15T10:36:49.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-05T18:37:34.000Z (about 1 year ago)
- Last Synced: 2025-04-10T01:13:42.902Z (2 months ago)
- Topics: badges, documentation, github-readme, readme
- Language: JavaScript
- Homepage: http://pufler.dev/badge-it/
- Size: 301 KB
- Stars: 224
- Watchers: 5
- Forks: 25
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Badge-It
[](https://github.com/pujux/badge-it/stargazers)
[](https://github.com/pujux/badge-it/issues)
[](https://github.com/pujux/badge-it/network)
[](https://github.com/pujux/badge-it/blob/main/LICENSE)
[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fpujux%2Fbadge-it)## Table of Contents
- [Usage](#available-badges-🔥)
- [Ideas](#got-an-idea-for-a-badge-)
- [License](#license)## Available badges 🔥
All endpoints support the parameters you can also use for [shields.io](https://shields.io) badges, you can check out their style documentation [here](https://shields.io/#styles).
Visits Badge
Returns a badge containing the visitor counter for your repository
Endpoint
https://badges.pufler.dev/visits/{username}/{repo}
Markdown
[](https://badges.pufler.dev)
---
Years Badge
Returns a badge containing the number of years you have been a member
Endpoint
https://badges.pufler.dev/years/{username}
Markdown
[](https://badges.pufler.dev)
---
Repos Badge
Returns a badge containing the number of your public repositories
Endpoint
https://badges.pufler.dev/repos/{username}
Markdown
[](https://badges.pufler.dev)
---
Gists Badge
Returns a badge containing the number of your public gists
Endpoint
https://badges.pufler.dev/gists/{username}
Markdown
[](https://badges.pufler.dev)
---
Updated Badge
Returns a badge that shows when the repository was last updated
Endpoint
https://badges.pufler.dev/updated/{username}/{repo}
Markdown
[](https://badges.pufler.dev)
---
Created Badge
Returns a badge that shows when the repository was created
Endpoint
https://badges.pufler.dev/created/{username}/{repo}
Markdown
[](https://badges.pufler.dev)
---
Commits Badge
Returns a badge that shows the number of commits you have published in a specified periodicity (yearly, monthly, weekly, daily or all)
Endpoint
https://badges.pufler.dev/commits/{periodicity}/{username}
Markdown
[](https://badges.pufler.dev)
---
Contributors Display
Returns an SVG that displays all contributors of the specified repository
You can specify
size
in pixels that will be used for each avatar,padding
in pixels that will be used between the avatars,perRow
to control how many avatars are shown per row andbots
as either 'true' or 'false' to hide bot contributors
Endpoint
https://badges.pufler.dev/contributors/{user}/{repo}?size={number}&padding={number}&perRow={number}&bots={boolean}
Markdown
[](https://badges.pufler.dev)
---
Last Stars Display
Returns an SVG that displays the last starred repositories of the specified user
You can specify
count
to control how many starred repositories will be shown,padding
in pixels that will be used between the repositories andperRow
to control how many repositories will be shown per row
Endpoint
https://badges.pufler.dev/last-stars/{user}?count={number}&padding={number}&perRow={number}
Markdown
[](https://badges.pufler.dev)
## Got an idea for a badge? 😀
Create an [issue](https://github.com/pujux/badge-it/issues/new)!
## License
Badge-It is licensed under the [BSD 3-Clause License](LICENSE).