npm.version

stable Standard

Metadata of one specific published npm version.

GET /v1/npm/version

What you get#

One npm record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit 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
`name`	string	yes	(required)	npm package name, e.g. react or @babel/core	max 214 chars; must match `(?:@[a-z0-9-~][a-z0-9-._~]/)?[a-z0-9-~][a-z0-9-._~]`; trimmed, lowercased
`version`	string	yes	(required)	Exact version, e.g. 18.2.0	max 64 chars; must match `[A-Za-z0-9][A-Za-z0-9._+-]{0,63}`; trimmed

Request#

curl "https://api.onekey.dev/v1/npm/version?name=react&version=18.2.0" \
  -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."
    },
    "package": {
      "version": "18.2.0",
      "license": "MIT",
      "homepageUrl": "https://reactjs.org/",
      "deprecated": null,
      "dependencies": {
        "loose-envify": "^1.1.0"
      }
    },
    "ext": {
      "downloadUrl": "https://registry.npmjs.org/react/-/react-18.2.0.tgz",
      "unpackedSize": 316108,
      "files": 20,
      "engines": {
        "node": ">=0.10.0"
      }
    },
    "author": {
      "username": "gnoff"
    }
  },
  "metadata": {
    "platform": "npm",
    "endpoint": "version",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "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
`name`	`entity.name`	-
`version`	`package.version`	-
`description`	`entity.description`	-
`license`	`package.license`	-
`homepage`	`package.homepageUrl`	`safeUrl`
`dist.tarball`	`ext.downloadUrl`	`safeUrl`
`dist.unpackedSize`	`ext.unpackedSize`	`toNumber`
`dist.fileCount`	`ext.files`	`toNumber`
`_npmUser.name`	`author.username`	-
`deprecated`	`package.deprecated`	-
`dependencies`	`package.dependencies`	-
`engines`	`ext.engines`	-

Caching and freshness#

Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
Between 1 hour and 1 day 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 3 days more (marked stale).
A "not found" is remembered for 5 minutes 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`	That record does not exist. Free; do not retry.
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).