Create Your Badge
Enter your npm package name and customize your badge
Style
Data
Color
Package not found:
Invalid package name:
Badge Styles
Choose the style that best fits your project
Compact Badges
Perfect for GitHub READMEs -shields.io inspired, minimal height, maximum information
Shields
GitHub README compatible, supports multi-data
?style=shields&data=version
?style=shields&data=n,v,u,d&color=blue
Flat
Modern design, rounded or square corners
?style=flat&data=n,v,d&color=brightgreen
?style=flat-square&data=downloads
Scoped Packages
Great for showing full scoped names
?style=shields&data=n,v,u
?style=flat&data=n,d
Single Data Badges
Show just one data point per badge
?style=shields&data=v
?style=flat&data=d
?style=flat-square&data=u
Detailed Badges
Classic NodeICO badges with comprehensive package information
Standard
Classic NodeICO badge with full details
Standard with Data
Include stars and download counts
?data=s,d
Compact
Condensed single-line information
?style=compact
Mini
Minimal badge with install command only
?style=mini
Quick Start
Add your badge to any README or documentation
HTML
<a href="https://nodei.co/npm/package-name"><img src="https://nodei.co/npm/package-name.svg"></a>
Markdown
[](https://nodei.co/npm/package-name)
API Reference
Complete reference for all badge parameters and options
Badge Styles
Choose your badge style with thestyle
parameter:
Style | Description | Data Support |
---|---|---|
standard | Classic NodeICO badge (default) | stars, downloads |
compact | Single-line condensed format | none |
mini | Minimal install command only | none |
shields | GitHub README compatible | all data types |
flat | Modern flat design | all data types |
flat-square | Flat design with square corners | all data types |
Data Parameters
Add package information with thedata
parameter.Order matters - data appears in the order specified:
Parameter | Alias | Description | Example Output |
---|---|---|---|
name | n | Package name | express |
version | v | Latest version | v4.18.2 |
downloads | d | Weekly downloads | 23M dl/w |
stars | s | GitHub stars | 63k★ |
updated | u | Last publish date | 2mo ago |
Color Options
Customize badge colors with thecolor
parameter. Works with all badge styles!
Color | Value | Example |
---|---|---|
Default (npm red) | #cb3837 | |
Blue | blue | |
Bright Green | brightgreen | |
Orange | orange |
Also supports:green
,yellowgreen
,yellow
,red
,lightgrey
, or any hex color like#ff6b6b
Usage Examples
Basic Badge
/npm/express.svg
Standard badge with default information
Shields Style with Version
/npm/express.svg?style=shields&data=version
Compact GitHub-compatible badge showing version
Multi-Data Badge
/npm/express.svg?style=shields&data=n,v,d
Shows name, version, and downloads in that order
Reordered Data
/npm/express.svg?style=flat&data=d,v,u
Shows downloads first, then version, then updated date
URL Format
https://nodei.co/npm/<package-name>.svg?<parameters>
Scoped packages: Include the full scope in the URL:/npm/@babel/core.svg
Multiple data points: Separate with commas:data=n,v,d
Legacy support: Old parameters likedownloads=true
still work