Important
In order to display your statistics you need to host this API yourself, for this I recommend using Deno Deploy.
Note
Don't forget to replace example YOUR-DEPLOY parameter with real value.
- Fork this repository
- Go to Deno Deploy and connect your GitHub account
- Click
New Projectand select your forked repository - Select
mainbranch - Add
WAKATIME_API_KEYenvironment variable with your Wakatime API Key - Click
Link - Visit
https://YOUR-DEPLOY/api/badgein your browser
- Clone this repository
git clone https://github.com/IgorKowalczyk/wakatime-hours - Create new file named
.envRemember - the file is super secret, better to not share it. - In
.envfile set this values:WAKATIME_API_KEY- Your Wakatime API KeyPORT- Port on which the API will be available (optional, default:8080)
- Run
deno task devto start the project in development mode ordeno task startto run the project in production mode. - Visit
http://localhost:8080in your browser (orhttp://localhost:${PORT}if you set custom port)
Warning
This API no longer supports Vercel hosting. But if you want to host this API on Vercel, you can use old version of this API (>= 2.x.x) which is available here.
The old version of this API is no longer supported and will not receive any updates!
GET https://YOUR-DEPLOY/api/badge?style=${style}&color=${color}&label=${label}| Parameter | Type | Description | Available values | Default value |
|---|---|---|---|---|
style |
string |
Optional. The style of the badge | Available styles | flat |
color |
string |
Optional. The color of the badge | Available colors | blue |
label |
string |
Optional. The label of the badge | Any string | Wakatime |
Note
The default style is flat
| Style | Example | Usage |
|---|---|---|
flat |
style=flat |
|
flat-square |
style=flat-square |
|
for-the-badge |
style=for-the-badge |
|
plastic |
style=plastic |
|
social |
style=social |
Note
To apply the style, add to the URL ?style=YOUR-STYLE, if you use other parameters you can use &style=YOUR-STYLE
Note
The default color is blue
| Color | Example | Usage | Label Color | Label usage |
|---|---|---|---|---|
brightgreen |
color=brightgreen |
labelColor=brightgreen |
||
green |
color=green |
labelColor=green |
||
yellow |
color=yellow |
labelColor=yellow |
||
yellowgreen |
color=yellowgreen |
labelColor=yellowgreen |
||
orange |
color=orange |
labelColor=orange |
||
red |
color=red |
labelColor=red |
||
blue |
color=blue |
labelColor=blue |
||
grey |
color=grey |
labelColor=grey |
||
lightgrey |
color=lightgrey |
labelColor=lightgrey |
||
blueviolet |
color=blueviolet |
labelColor=blueviolet |
||
ff69b4 |
color=ff69b4 |
labelColor=ff69b4 |
Note
To apply the style, add to the URL ?color=YOUR-COLOR, if you use other parameters you can use &color=YOUR-COLOR
Warning
HEX colors should be used without # symbol prefix.
You can overwrite default Wakatime text with your own label.
Note
Replace whitespace with + character in multi-word labels.
- Go to Wakatime and login to your account
- Go to API Keys page and copy your API Key
- Paste your API Key to
.envfile or add it as environment variable on your hosting - Restart your API if needed
Important
Wakatime API Key is super secret, better to not share it. If you share it, anyone can use your API Key to get or modify your statistics.
If you come across any errors or have suggestions for improvements, please create a new issue here and describe it clearly.
When submitting a pull request, please follow these steps:
- Clone this repository
https://github.com/IgorKowalczyk/wakatime-hours.git - Create a branch from
mainand give it a meaningful name (e.g.my-awesome-new-feature). - Open a pull request on GitHub and clearly describe the feature or fix you are proposing.
This project is licensed under the MIT. See the LICENSE file for details
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent