Badges

npmx.dev offers many different SVG badges with stats about any package via its API. You can get the Markdown code to display an accessible badge which links to the package URL on npmx.dev with the following interactive generator:

Package Name

Badge Type

VersionLicenseSizeDownloadsDownloads per DayDownloads per WeekDownloads per MonthDownloads per YearVulnerabilitiesDependenciesCreatedUpdatedEnginesTypesMaintainersDeprecatedNameLikes

Preview & Action

Copy

Available Badge Types

• version: Shows the latest or specific version of the package.
• license: Displays the package license (e.g., MIT, Apache-2.0).
• size: Shows the install size (via Bundlephobia) or unpacked size.
• downloads: Displays monthly download statistics.
• downloads-day: Displays daily download statistics.
• downloads-week: Displays weekly download statistics.
• downloads-month: Alias for monthly download statistics.
• downloads-year: Displays yearly download statistics.
• vulnerabilities: Shows the number of vulnerabilities found via OSV. /
• dependencies: Lists the total count of package dependencies.
• created: Displays the date the package was first published.
• updated: Displays the date of the most recent modification.
• engines: Shows the supported Node.js version range.
• types: Indicates if TypeScript types are included. /
• maintainers: Displays the total count of package maintainers.
• deprecated: Shows if the package is active or deprecated. /
• name: Simple badge displaying the package name.
• likes: Shows the total count of package likes.

Examples

# Version Badge

[![Open on npmx.dev](https://npmx.dev/api/registry/badge/version/nuxt)](https://npmx.dev/package/nuxt)

# License Badge

[![Open on npmx.dev](https://npmx.dev/api/registry/badge/license/vue)](https://npmx.dev/package/vue)

# Monthly Downloads

[![Open on npmx.dev](https://npmx.dev/api/registry/badge/downloads/lodash)](https://npmx.dev/package/lodash)

# Scoped Package (Install Size)

[![Open on npmx.dev](https://npmx.dev/api/registry/badge/size/@nuxt/kit)](https://npmx.dev/package/@nuxt/kit)

# Specific Version

[![Open on npmx.dev](https://npmx.dev/api/registry/badge/version/react/v/18.0.0)](https://npmx.dev/package/react)

Customization Parameters

You can further customize your badges by appending query parameters to the badge URL.

Use this generator to get the Markdown code you desire:

Package Name

Badge Type

VersionLicenseSizeDownloadsDownloads per DayDownloads per WeekDownloads per MonthDownloads per YearVulnerabilitiesDependenciesCreatedUpdatedEnginesTypesMaintainersDeprecatedNameLikes

Preview & Action

Copy

Label Text

Badge Value

Label Color

#

Badge Color

#

Use package name as label

Badge Styledefaultshieldsiocompact

label

Overrides the default label text. You can pass any string to customize the label displayed on the left half of the badge.

• Default: Depends on the badge type (e.g., "version", "downloads/mo").
• Usage: ?label=YOUR_LABEL

value

Overrides the default value text of the badge. You can pass any string to customize the value displayed on the right half of the badge.

• Default: Calculated values depending on the badge type (e.g., "v4.2.0", "5.4M").
• Usage: ?label=YOUR_LABEL

labelColor

Overrides the default label color. You can pass a standard hex code (with or without the # prefix). The label text color is automatically chosen (black or white) based on WCAG contrast ratio, so the badge remains readable.

• Default: #0a0a0a
• Usage: ?labelColor=HEX_CODE

color

Overrides the default strategy color. You can pass a standard hex code (with or without the # prefix). The text color is automatically chosen (black or white) based on WCAG contrast ratio, so the badge remains readable.

• Default: Depends on the badge type (e.g., version is blue, downloads are orange).
• Usage: ?color=HEX_CODE

name

When set to true, this parameter replaces the static category label (like "version" or "downloads/mo") with the actual name of the package. This is useful for brand-focused READMEs.

• Default: false
• Usage: ?name=true

style

Overrides the badge appearance.

• default — the standard npmx.dev look at 20px tall.
• shieldsio — the classic shields.io-compatible look at 20px tall, useful when you need the badge to sit alongside existing shields.io badges.
• compact — the same modern look and 20px height as default but with tight 5px text padding and no enforced minimum side width. Long built-in labels are also shortened (e.g. install size → size, downloads/mo → dl/mo, dependencies → deps, maintainers → maint) so the badge can take up roughly 20–50% less horizontal space in READMEs. Pass an explicit label or name=true to opt out of the shortening.
• Default: default
• Usage: ?style=compact or ?style=shieldsio