npm

Badges for npm packages — version, downloads, license, types, and more.

Display live stats for any npm package.

npm version
Version (branded)
npm downloads
Monthly downloads
npm types
Types (blue theme)
npm license
License (outline)
npm node
Node version
npm dependents
Dependents

Available badges

BadgeEndpointDescription
Version/npm/{package}Latest version
Downloads/npm/dw/{package}, /npm/dm/{package}, etc.Download counts
License/npm/license/{package}Package license
Node Version/npm/node/{package}Required Node.js version
Types/npm/types/{package}TypeScript types status
Dependents/npm/dependents/{package}Dependent package count

Quick examples

![version](https://shieldcn.dev/npm/react.svg)
![downloads](https://shieldcn.dev/npm/dm/react.svg)
![license](https://shieldcn.dev/npm/license/react.svg)
![types](https://shieldcn.dev/npm/types/react.svg)

Scoped packages

For scoped packages like @types/react, use the full scope:

![version](https://shieldcn.dev/npm/@types/react.svg)
![version](https://shieldcn.dev/npm/v/@scope/package.svg)

Endpoint details

Open focused sandboxes and exact URL shapes for each npm badge type.

Use these sections when you need the exact URL shape or an interactive builder for a specific badge type. Most users only need the table and quick examples above.

npm Dependents

This section covers the npm/dependents badge endpoint.

Show how many other packages depend on this package.

GET/npm/dependents/:package.svg

Path Parameters

required
![badge](https://shieldcn.dev/npm/dependents/react.png)
badge preview

URL format

/npm/dependents/{package}.svg

Copy-paste examples

Default — ecosystem adoption signal

![dependents](https://shieldcn.dev/npm/dependents/react.svg)

Outline with custom label — social proof for package pages

![dependents](https://shieldcn.dev/npm/dependents/react.svg?variant=outline&label=used%20by)

npm Downloads

This section covers the npm/downloads badge endpoint.

Show weekly, monthly, yearly, or total download counts.

GET/npm/dm/:package.svg

Path Parameters

required
![badge](https://shieldcn.dev/npm/dm/react.png)
badge preview

URL formats

PeriodEndpointExample
Weekly/npm/dw/{package}/npm/dw/react
Monthly/npm/dm/{package}/npm/dm/react
Yearly/npm/dy/{package}/npm/dy/react
Total/npm/dt/{package}/npm/dt/react
Legacy/npm/{package}/downloads/npm/react/downloads

Copy-paste examples

Default — monthly downloads as a growth signal

![monthly downloads](https://shieldcn.dev/npm/dm/react.svg)

Outline — long-term adoption signal

![total downloads](https://shieldcn.dev/npm/dt/react.svg?variant=outline)

npm License

This section covers the npm/license badge endpoint.

Show the license specified in a package's package.json.

GET/npm/license/:package.svg

Path Parameters

required
![badge](https://shieldcn.dev/npm/license/react.png)
badge preview

URL format

/npm/license/{package}.svg

Copy-paste examples

Default — license badge for package pages

![license](https://shieldcn.dev/npm/license/react.svg)

Ghost — subtle metadata badge for footer rows

![license](https://shieldcn.dev/npm/license/react.svg?variant=ghost)

npm Node Version

This section covers the npm/node badge endpoint.

Show the Node.js version requirement from a package's engines.node field.

GET/npm/node/:package.svg

Path Parameters

required
![badge](https://shieldcn.dev/npm/node/react.png)
badge preview

URL format

/npm/node/{package}.svg

Copy-paste examples

Outline — good compatibility badge for libraries

![node version](https://shieldcn.dev/npm/node/next.svg?variant=outline)

With Node.js logo — branded compatibility badge

![node version](https://shieldcn.dev/npm/node/next.svg?logo=nodedotjs)

Notes

  • Returns the engines.node value from package.json
  • Shows "any" if no Node version is specified

npm Types

This section covers the npm/types badge endpoint.

Show whether a package includes TypeScript types or has types available via DefinitelyTyped.

GET/npm/types/:package.svg

Path Parameters

required
![badge](https://shieldcn.dev/npm/types/react.png)
badge preview

URL format

/npm/types/{package}.svg

Examples

![types](https://shieldcn.dev/npm/types/react.svg)
![types](https://shieldcn.dev/npm/types/typescript.svg)
![types](https://shieldcn.dev/npm/types/zod.svg)

Type status values

ValueMeaning
bundledPackage includes its own TypeScript definitions
@types/{pkg}Types available via DefinitelyTyped
noneNo TypeScript types available

Copy-paste examples

Blue theme — highlights TS support clearly

![types](https://shieldcn.dev/npm/types/react.svg?theme=blue)

Branded with TypeScript logo — strong developer experience signal

![types](https://shieldcn.dev/npm/types/zod.svg?variant=branded&logo=typescript)

npm Version

This section covers the npm/version badge endpoint.

Show the current published version of a package.

GET/npm/:package.svg

Path Parameters

required

Unscoped (react) or scoped (@types/react).

![badge](https://shieldcn.dev/npm/react.png)
badge preview

URL formats

/npm/{package}.svg
/npm/v/{package}.svg
/npm/v/{package}/{tag}.svg

Copy-paste examples

Default — clean version badge for READMEs

![npm version](https://shieldcn.dev/npm/react.svg)

Branded — npm's official red

![npm version](https://shieldcn.dev/npm/react.svg?variant=branded)

Scoped package — secondary variant

![npm version](https://shieldcn.dev/npm/@types/react.svg?variant=secondary)

Data source

No API key required. Cached 1 hour.