Skip to content

Latest commit

 

History

History
87 lines (68 loc) · 3.46 KB

File metadata and controls

87 lines (68 loc) · 3.46 KB

GET /badges

Generate one or more badges from a single query-style endpoint.

Route

  • /badges?username=pphatdev&name=visitors

Required Params

  • username

Optional Params

Param Description
repo Repository name for repo-level badges such as stars or forks
name Comma-separated badge names
theme One theme or multiple comma-separated themes cycled across badges
effect wave or glow
column Grid columns for multi-badge output (1-50)
size small, medium, or large
customLabel Custom label text
labelColor Label text color
labelBackground Label background color
iconColor Icon color
valueColor Value text color
valueBackground Value background color
hideFrame Hide frame (true/false)
hideIcon Hide icon (true/false)

Supported User Badge Names

  • visitors
  • repositories
  • organization
  • languages
  • followers
  • total-stars
  • total-contributors
  • total-commits
  • total-code-reviews
  • total-issues
  • total-pull-requests
  • total-joined-years

Supported Repo Badge Names

  • stars
  • forks
  • contributors
  • issues
  • pull-requests
  • watchers
  • size

Single Badge Examples

visitors repositories followers total-stars

Repo Badge Examples

repo-stars repo-forks

Style Examples

Param Preview
theme theme
customLabel customLabel
labelColor labelColor
labelBackground labelBackground
iconColor iconColor
valueColor valueColor
valueBackground valueBackground
hideFrame hideFrame
hideIcon hideIcon

Combined Examples

combined-stars combined-followers combined-repositories