query-registry

!Language

query-registry is an API wrapper for the npm registry API.

Features

- Provides functions to:
- Get registry metadata.
- Get registry public keys.
- Get packuments (package documents) with full package metadata.
- Get abbreviated packuments with installation data only.
- Get package manifests for each version of a package.
- Get download counts for the registry and for packages.
- Search packages by name and other specific criteria.
- Works in the browser.
- Validates registry responses with zod.
- Automatically caches registry responses for a short time.
- Supports third-party npm-compatible registries.

Useful resources

- Explore the API on jsDocs.io
- View package contents on unpkg
- View repository on GitHub
- Read the changelog on GitHub

Install

> [!NOTE]
> Make sure you have Zod v4 installed in your application to use this package.

Using npm:

``
npm add zod query-registry
`

Using yarn:

`
yarn add zod query-registry
`

Using pnpm:

`
pnpm add zod query-registry
`

Using bun:

`
bun add zod query-registry
`

Usage examples

$3

Get the metadata about the npm registry itself, if available:

`typescript
import { getRegistryMetadata } from "query-registry";

const metadata = await getRegistryMetadata();
`

Get the public signing keys for the npm registry:

`typescript
import { getRegistrySigningKeys } from "query-registry";

const { keys } = await getRegistrySigningKeys();
`

$3

Get the abbreviated packument containing only the necessary data to install the react package:

`typescript
import { getAbbreviatedPackument } from "query-registry";

const abbrPackument = await getAbbreviatedPackument("react");
`

Get the full packument containing all the data available about the react package:

`typescript
import { getPackument } from "query-registry";

const packument = await getPackument("react");
`

$3

Get the manifest containing the original package.json data plus additional registry metadata for the latest version of the react package:

`typescript
import { getPackageManifest } from "query-registry";

const manifest = await getPackageManifest("react");
`

Get the manifest for react@18.2.0 (semver version):

`typescript
import { getPackageManifest } from "query-registry";

const manifest = await getPackageManifest("react", "18.2.0");
`

Get the manifest for react@next (distribution tag):

`typescript
import { getPackageManifest } from "query-registry";

const manifest = await getPackageManifest("react", "next");
`

$3

Search packages related to react (e.g., react, react-dom, ...):

`typescript
import { searchPackages } from "query-registry";

const results = await searchPackages({ text: "react" });
`

$3

Get the total number of downloads for package react for the last month:

`typescript
import { getPackageDownloads } from "query-registry";

const { downloads } = await getPackageDownloads("react", "last-month");
`

There are also these other download counts functions available: getBulkDailyPackageDownloads, getBulkPackageDownloads, getDailyPackageDownloads, getDailyRegistryDownloads and getPackageVersionsDownloads.

$3

Clear the internal cache.

`typescript
import { cache } from "query-registry";

cache.clear();
`

See the quick-lru package for the cache API.

License

`
MIT
``

Copyright (c) 2025 Edoardo Scibona

See LICENSE file.