npm.search

stable Advanced

Search the npm registry (with popularity and quality scores).

GET /v1/npm/search

What you get#

A list of npm results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

Also works with: Multi-platform search as the npm search leg. Any batch can include it.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/npm/search?q=react" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real npm response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "name": "react",
        "description": "React is a JavaScript library for building user interfaces.",
        "url": "https://www.npmjs.com/package/react",
        "updatedAt": "2026-09-09T17:21:30Z",
        "stats": {
          "score": 2198.1274
        }
      },
      "package": {
        "version": "19.3.0",
        "repositoryUrl": null
      },
      "author": {
        "username": "GitHub Actions"
      },
      "ext": {
        "downloadsMonthly": 647699414,
        "dependents": 216373
      }
    },
    {
      "entity": {
        "name": "react-is",
        "description": "Brand checking of React Elements.",
        "url": "https://www.npmjs.com/package/react-is",
        "updatedAt": "2026-09-09T17:17:33Z",
        "stats": {
          "score": 261.65497
        }
      },
      "package": {
        "version": "19.3.0",
        "repositoryUrl": null
      },
      "author": {
        "username": "GitHub Actions"
      },
      "ext": {
        "downloadsMonthly": 1315146304,
        "dependents": 4125
      }
    }
  ],
  "metadata": {
    "platform": "npm",
    "endpoint": "search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`package.name`	`entity.name`	-
`package.version`	`package.version`	-
`package.description`	`entity.description`	-
`package.links.npm`	`entity.url`	`safeUrl`
`package.links.repository`	`package.repositoryUrl`	`safeUrl`
`package.date`	`entity.updatedAt`	`toIsoDate`
`package.publisher.username`	`author.username`	-
`downloads.monthly`	`ext.downloadsMonthly`	`toNumber`
`dependents`	`ext.dependents`	`toNumber`
`score.final`	`entity.stats.score`	`toNumber`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).