Logo
Using Stats from stats.pphat.top

Using Stats from stats.pphat.top

about 5 hours ago

๐Ÿ“– Overview

Table of Contents

  1. What is Stats of GitHub Stats?
  2. How to Use Stats endpoint
  3. Params for Stats endpoint
  4. Themes Presets
  5. Hide Title
  6. Hide Ranking
  7. Avatar Mode
  8. Customize Title
  9. Data Border Style
  10. Data Border Framing Style
  11. Data Border Framing Offset

๐Ÿ“– What is Stats of GitHub Stats?

Stats is a part of GitHub Stats API endpoint that allows you to generate beautiful stats cards for your README and portfolio.

๐Ÿ“– How to Use Stats endpoint

This is how it looks like when you use the Stats endpoint:

shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&avatar_mode=radar)

Stats Card

Also you can see the real usage on my GitHub profile.

๐Ÿš€ Params for Stats endpoint

These are params of Stats endpoint:

ParamDescriptionRequired
usernameGitHub usernameYes
themeTheme presetNo
hide_titleHide titleNo
hide_rankHide rankNo
avatar_modenone, radarNo
custom_titleCustom title textNo
data_border_stylesolid, frameNo
data_border_framein, outNo

๐ŸŽจ Themes Presets

Pick a theme by adding the query parameter below:

theme=<preset-name>

Example:

shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&theme=tokyonight)

More examples:

shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&theme=default)
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&theme=dracula)
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&theme=github_dark)
  • default
  • dark
  • tokyonight
  • dracula
  • gruvbox
  • github_dark
  • rose_pine
  • nord

๐Ÿ“‹ All preset names

All themes are shown in the gallery below.

Hide title

Use this to hide the card title.

Parameter: hide_title=true

shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&hide_title=true)

Stats Card

Hide Ranking

Use this to hide the rank badge.

Parameter: hide_rank=true

shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&hide_rank=true)

Stats Card

Avatar Mode

Control avatar rendering mode.

Supported values:

  • none
  • radar
shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&avatar_mode=none)
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&avatar_mode=radar)

Stats Card

Customize Title

Set your own title text.

Parameter: custom_title=<your-title>

shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&custom_title=My%20GitHub%20Stats)

Stats Card

Data Border Style

Control the border style around data sections.

Supported values:

  • solid
  • frame
shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&data_border_style=solid)
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&data_border_style=frame)

Stats Card

Data Border framing style

Control frame direction when using data_border_style=frame.

Supported values:

  • in
  • out
shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&data_border_style=frame&data_border_frame=in)
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&data_border_style=frame&data_border_frame=out)

Stats Card

Data Border framing offset

Adjust frame spacing (offset) from content.

If your API version supports frame offset, use:

Parameter: data_border_frame_offset=<number>

shell
![Stats Card](https://stats.pphat.top/stats?username=pphatdev&data_border_style=frame&data_border_frame=in&data_border_frame_offset=6)

Stats Card

๐Ÿ’– Thank you

Is this article helpful ? Check out the project

Thanks for reading! ๐Ÿ’–

#article#github-readme