A collection of API endpoints to simplify GitHub README badges. With predefined badges for standard technologies and platforms, along with custom badges you can make yourself.
Here is a list of all the routes you can find under https://badgelab.dev/api/*. Along with their params and a brief description.
Route:
https://badgelab.dev/api/customBadge
This route can be used to create your own badge, customizing the color, text, etc.
Params:
| Name | Description | Example | Required | Default |
|---|---|---|---|---|
| name | Text shown on badge | Hello World | true | NA |
| textColor | Color of text show on badge | FFFFFF | false | white |
| bgColor | Color of background show on badge | 000000 | false | black |
| image | Display an icon with the badge (must be svg) | https://sample.com/some.svg | false | "null" |
| noLogo | Force logo to not be shown | true | false | false |
| rounded | Force badge to be rounded | true | false | false |
Route:
https://badgelab.dev/api/badge/:name
This route can be used to get predefined badges that live in the badgeList.json file.
Params:
| Name | Description | Example | Required | Default |
|---|---|---|---|---|
| :name | Id of badge you want to fetch | javascript | true | NA |
| noLogo | Force logo to not be shown | true | false | false |
| rounded | Force badge to be rounded | true | false | false |
Badges are defined within each section below and can be accessed with the badge route
| ID | Rendered | Route |
|---|---|---|
| html5 | https://badgelab.dev/api/badge/html5 | |
| html5-white | https://badgelab.dev/api/badge/html5-white | |
| css3 | https://badgelab.dev/api/badge/css3 | |
| css3-white | https://badgelab.dev/api/badge/css3-white | |
| javascript | https://badgelab.dev/api/badge/javascript | |
| javascript-white | https://badgelab.dev/api/badge/javascript-white | |
| javascript-black | https://badgelab.dev/api/badge/javascript-black | |
| python | https://badgelab.dev/api/badge/python | |
| python-white | https://badgelab.dev/api/badge/python-white | |
| python-black | https://badgelab.dev/api/badge/python-black | |
| swift | https://badgelab.dev/api/badge/swift | |
| swift-white | https://badgelab.dev/api/badge/swift-white | |
| java | https://badgelab.dev/api/badge/java | |
| java-white | https://badgelab.dev/api/badge/java-white | |
| markdown | https://badgelab.dev/api/badge/markdown | |
| json | https://badgelab.dev/api/badge/json | |
| arduino-white | https://badgelab.dev/api/badge/arduino-white | |
| c-white | https://badgelab.dev/api/badge/c-white | |
| cpp-white | https://badgelab.dev/api/badge/cpp-white |
| ID | Rendered | Route |
|---|---|---|
| react | https://badgelab.dev/api/badge/react | |
| jquery | https://badgelab.dev/api/badge/jquery | |
| jquery-white | https://badgelab.dev/api/badge/jquery-white | |
| tailwindcss | https://badgelab.dev/api/badge/tailwindcss | |
| tailwindcss-white | https://badgelab.dev/api/badge/tailwindcss-white |
| ID | Rendered | Route |
|---|---|---|
| facebook-white | https://badgelab.dev/api/badge/facebook-white | |
| linkedin-white | https://badgelab.dev/api/badge/linkedin-white | |
| instagram-white |  |
https://badgelab.dev/api/badge/instagram-white |
| youtube-white | https://badgelab.dev/api/badge/youtube-white | |
| website-white | https://badgelab.dev/api/badge/website-white | |
| portfolio-white | https://badgelab.dev/api/badge/portfolio-white | |
| email-white | https://badgelab.dev/api/badge/email-white | |
| behance-white | https://badgelab.dev/api/badge/behance-white | |
| x-white | https://badgelab.dev/api/badge/x-white | |
| twitter-white | https://badgelab.dev/api/badge/twitter-white |
| ID | Rendered | Route |
|---|---|---|
| w3schools | https://badgelab.dev/api/badge/w3schools | |
| w3schools-white | https://badgelab.dev/api/badge/w3schools-white | |
| khan-academy | https://badgelab.dev/api/badge/khan-academy | |
| khan-academy-white | https://badgelab.dev/api/badge/khan-academy-white | |
| codecademy | https://badgelab.dev/api/badge/codecademy | |
| mdn | https://badgelab.dev/api/badge/mdn | |
| geeksforgeeks | https://badgelab.dev/api/badge/geeksforgeeks |
| ID | Rendered | Route |
|---|---|---|
| firebase | https://badgelab.dev/api/badge/firebase | |
| firebase-black | https://badgelab.dev/api/badge/firebase-black | |
| netlify | https://badgelab.dev/api/badge/netlify | |
| github-pages | https://badgelab.dev/api/badge/github-pages |
| ID | Rendered | Route |
|---|---|---|
| github | https://badgelab.dev/api/badge/github | |
| vscode | https://badgelab.dev/api/badge/vscode | |
| vscode-white | https://badgelab.dev/api/badge/vscode-white |
| ID | Rendered | Route |
|---|---|---|
| firefox | https://badgelab.dev/api/badge/firefox | |
| firefox-white | https://badgelab.dev/api/badge/firefox-white | |
| chrome | https://badgelab.dev/api/badge/chrome | |
| chrome-white | https://badgelab.dev/api/badge/chrome-white | |
| safari | https://badgelab.dev/api/badge/safari | |
| safari-white | https://badgelab.dev/api/badge/safari-white | |
| edge | https://badgelab.dev/api/badge/edge | |
| edge-white | https://badgelab.dev/api/badge/edge-white | |
| opera | https://badgelab.dev/api/badge/opera | |
| opera-white | https://badgelab.dev/api/badge/opera-white | |
| brave | https://badgelab.dev/api/badge/brave | |
| brave-white | https://badgelab.dev/api/badge/brave-white | |
| tor | https://badgelab.dev/api/badge/tor | |
| tor-white | https://badgelab.dev/api/badge/tor-white |
| ID | Rendered | Route |
|---|---|---|
| debian | https://badgelab.dev/api/badge/debian | |
| debian-white | https://badgelab.dev/api/badge/debian-white | |
| ubuntu | https://badgelab.dev/api/badge/ubuntu | |
| ubuntu-white | https://badgelab.dev/api/badge/ubuntu-white | |
| windows | https://badgelab.dev/api/badge/windows | |
| windows-white | https://badgelab.dev/api/badge/windows-white |