Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

npm Packages API

Package metadata retrieval, including full packuments and version-specific documents.

npm Packages API is one of 10 APIs that npm publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Packages. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://registry.npmjs.org.

2 operations 2 paths 6 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://registry.npmjs.org
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

npm Packages API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — npm access token provided as a Bearer token.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Packages 2

Package metadata retrieval, including full packuments and version-specific documents.

GET
/{package}
Get a package document (packument)
getPackageDocument 1 param → 200404
GET
/{package}/{version}
Get a specific package version
getPackageVersion 2 params → 200404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PackageVersion (19 properties), PackageDocument (16 properties), Distribution (6 properties), Person (3 properties). Each schema is shown below with its type and property counts.

PackageVersion
object
Metadata for a specific version of a package, including dependencies, scripts, and distribution information.
19 properties
Distribution
object
Distribution metadata for a specific published version, including integrity hashes and tarball location.
6 properties
Error
object
An error response from the registry.
2 properties
PackageDocument
object
A full package document (packument) containing all metadata for a package, including every published version.
16 properties
Repository
object
Source code repository information.
2 properties
Person
object
A person object representing a user, author, or maintainer.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

npm-packages-api-openapi.yml Raw ↑

Other APIs npm publishes across the network.

npm Registry API
npm Hooks API
npm Provenance
npm Downloads API
npm OIDC API
npm Search API
npm Tokens API
npm Trusted Publishers API