Skip to content

About

A dynamically generated stats for chess.com

Topics

Resources

Stars

2 stars

Watchers

1 watching

Forks

Latest commit

 

History

28 Commits

Folders and files

Repository files navigation

Chess Stats Card

Display your chess.com rating on your GitHub profile README.

⚡ Quick setup

  1. Star this repo 😁
  2. Place the code below in you repo and replace username with your own.
![Chess stats card](https://chess-stats-card.vercel.app/api/card?user=username)

It is recommended to self-host the project for better reliability.

🃏 Available Cards

Here are the different types of cards you can generate:

Card Name Endpoint Description Card
Card /api/card General profile stats card Card
Game Card /api/game Shows stats for a specific game mode (requires gameMode) Game Card

🔧 Options

⚠️ Important: Make sure to include ? before your first parameter, or your options won’t be applied.

Example: https://chess-stats-card.vercel.app/api/card?user=username

The user field is the only required option for all cards. All other fields are optional. To add additional field add &[parameter] to the link.

Parameter Type Description Example
user string Your Chess.com username magnuscarlsen
theme string Card theme – available themes: light, dark, midnight, etc... theme=ocean_dark
width float Width of the card width=420
height float Height of the card height=200
avatar boolean Toggle profile picture from Chess.com. true by default avatar=false
textColor string HEX or named color for body text textColor=#ffffff
titleColor string HEX or named color for the title titleColor=#00ff00
borderColor string HEX or named color for the border borderColor=#000000
bgColor string HEX or named color for the card background bgColor=#1a1a1a

Note: If you provide textColor, titleColor, borderColor, or bgColor, they will override the colors set by the selected theme.

🎮 Additional Options for Game Card

Parameter Type Description Example
gameMode string Game mode to show stats for (required for gamecard) gameMode=chess_blitz

Valid gameMode values: chess_rapid, chess_blitz, chess_bullet, chess960_daily and chess_daily.

🎨 Themes

All cards themes are set to default by default. Here are a few themes that you can do.

All themes
default default transparent transparent
shadow_red shadow_red shadow_green shadow_green
shadow_blue shadow_blue dark dark
radical radical merko merko
gruvbox gruvbox gruvbox_light gruvbox_light
tokyonight tokyonight onedark onedark
cobalt cobalt synthwave synthwave
high_contrast high_contrast dracula dracula
prussian prussian monokai monokai
vue vue vue_dark vue_dark
shades_of_purple shades_of_purple nightowl nightowl
buefy buefy blue_green blue_green
algolia algolia great_gatsby great_gatsby
darcula darcula bear bear
solarized_dark solarized_dark solarized_light solarized_light
chartreuse_dark chartreuse_dark nord nord
gotham gotham material_palenight material_palenight
graywhite graywhite vision_friendly_dark vision_friendly_dark
ayu_mirage ayu_mirage midnight_purple midnight_purple
calm calm flag_india flag_india
omni omni react react
jolly jolly maroongold maroongold
yeblu yeblu blueberry blueberry
slateorange slateorange kacho_ga kacho_ga
outrun outrun ocean_dark ocean_dark
city_lights city_lights github_dark github_dark
github_dark_dimmed github_dark_dimmed discord_old_blurple discord_old_blurple
aura_dark aura_dark panda panda
noctis_minimus noctis_minimus cobalt2 cobalt2
swift swift aura aura
apprentice apprentice moltack moltack
codeSTACKr codeSTACKr rose_pine rose_pine
catppuccin_latte catppuccin_latte catppuccin_mocha catppuccin_mocha
date_night date_night one_dark_pro one_dark_pro
rose rose holi holi
neon neon blue_navy blue_navy
calm_pink calm_pink halloween halloween
blood blood youtube_dark youtube_dark
dawnfox dawnfox javascript_dark javascript_dark
nightfox nightfox earth earth
soft_green soft_green leafy leafy
submarine_flowers submarine_flowers onedark_duo onedark_duo
monokai_metallian monokai_metallian tokyonight_duo tokyonight_duo
whatsapp_light whatsapp_light catppuccin_macchiato catppuccin_macchiato
black_ice black_ice rust_ferris_dark rust_ferris_dark
microsoft microsoft codestackr codestackr
microsoft_dark microsoft_dark taiga taiga
dayfox dayfox violet_punch violet_punch
highcontrast highcontrast modern_lilac modern_lilac
modern_lilac2 modern_lilac2 burnt_neon burnt_neon
sea sea hacker_inverted hacker_inverted
neon_blurange neon_blurange elegant elegant
shadow_orange shadow_orange holi_theme holi_theme
blux blux meta_light meta_light
windows_dark windows_dark hacker hacker
green_nur green_nur rising_sun rising_sun
material material shadow_brown shadow_brown
git_dark git_dark github_light github_light
gruvbox_duo gruvbox_duo nordfox nordfox
buefy_dark buefy_dark blueberry_duo blueberry_duo
humoris humoris horizon horizon
whatsapp_light2 whatsapp_light2 neon_dark neon_dark
rust_ferris_light rust_ferris_light iceberg iceberg
telegram telegram icegray icegray
navy_gear navy_gear deepblue deepblue
duskfox duskfox java_dark java_dark
github_green_purple github_green_purple github_dark_blue github_dark_blue
terafox terafox python_dark python_dark
dark_smoky dark_smoky deuteranopia_friend deuteranopia_friend
blood_dark blood_dark android_dark android_dark
carbonfox carbonfox catppuccin_frappe catppuccin_frappe
whatsapp_dark2 whatsapp_dark2 meta_dark meta_dark
violet_dark violet_dark sea_dark sea_dark
dark_minimalist dark_minimalist travelers_theme travelers_theme

🤝 Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.

Make sure your request is meaningful and you have tested the app locally before submitting a pull request.

Support

If you like this project, give it a ⭐ and share it with friends!

About

A dynamically generated stats for chess.com

Topics

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages