https://github.com/mattrltrent/stackoverflow_badge

A Stackoverflow stats badge for your GitHub profile. Try it!
https://github.com/mattrltrent/stackoverflow_badge

badge github-readme github-stats githubreadme profile-card profile-github profilecard readme-card readme-profile rust

Last synced: 21 days ago
JSON representation

A Stackoverflow stats badge for your GitHub profile. Try it!

• Host: GitHub
• URL: https://github.com/mattrltrent/stackoverflow_badge
• Owner: mattrltrent
• Created: 2023-05-02T07:55:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-26T22:32:52.000Z (7 months ago)
• Last Synced: 2024-04-26T23:25:11.939Z (7 months ago)
• Topics: badge, github-readme, github-stats, githubreadme, profile-card, profile-github, profilecard, readme-card, readme-profile, rust
• Language: Rust
• Homepage: https://stackoverflow-badge.herokuapp.com/
• Size: 474 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Stackoverflow Stats Badge For Your GitHub Profile 🚀

Example of it on my GitHub profile [here](https://github.com/mattrltrent). Star it if it helps you! ⭐️

1. **Full badge:**

 

   ![stackoverflow rep. badge](https://stackoverflow-badge.herokuapp.com/stackoverflow?username=13029516&period=year)

3. **With `&mini=true` URL param appended:**

 

   ![stackoverflow rep. badge](https://stackoverflow-badge.herokuapp.com/stackoverflow?username=13029516&period=year&mini=true)

## Adding full badge version

1. Go to [Stackoverflow](https://stackoverflow.com/), then click on your profile. Once on your profile, you should see a number in the URL bar. This is your **account ID**.

   For example, here is my account ID:

   

2. Displayed on the stats badge is "*+ some number of reputation per some time period*". You need to choose over what time period you want us to calculate your reputation gain. The options are `day`,  `week`, `month`, `quarter`, and `year`. This is your **period**.

3. Take the base URL, and insert your newly found **account ID** and **period** where appropriate: 

   

   For example, here is the URL for my account if I wanted to show my reputation gain quarterly:

   

4. Here is the copyable version, just change the "USERNAME" and "PERIOD": https://stackoverflow-badge.herokuapp.com/stackoverflow?username=USERNAME&period=PERIOD.

5. Insert this URL from step 4 into your GitHub profile's `README.md` exactly like this (obviously with your own failure text and personalized URL):

   `![some text to render if the image fails to load](step 4 URL)`

6. If you're still struggling, check out how I added it to my own profile's `README.md` [here](https://github.com/mattrltrent/mattrltrent/blob/main/README.md?plain=1).

## Adding mini badge version

This only shows the total reputation you have.

1. Do all the steps from the big badge above.

2. Append `&mini=true` to the URL (keep the other options, they just don't matter). Added via suggestion from [@yubinjodev](https://github.com/yubinjodev).

## Limitations

These restrictions shouldn't interfere with regular usage:

- The badge is cached for 15 minutes, so its data can possibly lag 15 minutes behind your true Stackoverflow stats. This is done to reduce server load.

- You're rate limited to loading 15 different stat badges every 60 seconds based on your IP.

- The StackAPI limits everyone to loading 300 different profiles every 24 hours based on IP.

## Feel free to create issues or PRs!

- Issues [here](https://github.com/mattrltrent/stackoverflow_badge/issues).

- PRs [here](https://github.com/mattrltrent/stackoverflow_badge/pulls).