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 Search API

Full-text search across the npm registry with weighted scoring.

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

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

This API exposes 1 operation across 1 path, and defines 3 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.

1 operations 1 paths 3 schemas 1 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 Search 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 1

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

Search 1

Full-text search across the npm registry with weighted scoring.

GET
/-/v1/search
Search packages
searchPackages 6 params → 200

Schemas 3

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

SearchResults
object
Search results from the npm registry search endpoint.
3 properties
SearchResultItem
object
A single search result item containing package metadata and scoring information.
3 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-search-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 Packages API
npm Tokens API
npm Trusted Publishers API