/npm/packages

POST /api/npm/packages

Price: 5 credits

Get npm package details by package name or npm package URL

How to use it

Get full details of an npm package by name (e.g. 'react', '@types/node') or npm package URL. Returns name, description, latest version, license, homepage, repository, funding link, keywords, author, maintainers, contributors, dist-tags, tarball/integrity info, engines, dependencies and peer dependencies (with counts), deprecation status, star count, the full version-publish history, and created/modified timestamps.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• package string required — Package name (e.g. 'react', '@types/node') or npm package URL (examples: "react", "@types/node", "https://www.npmjs.com/package/express"; minLength: 1)

Response

• @type string (default: "NpmPackage")
• name string required
• alias string required
• description string nullable
• version string (default: "")
• license string nullable
• homepage string nullable
• repository_url string nullable
• bugs_url string nullable
• funding_url string nullable
• keywords array (default: [])
• author object nullable
  • @type string (default: "NpmMaintainer")
  • name string (default: "")
  • email string nullable
  • url string nullable
• maintainers array (default: [])
  • @type string (default: "NpmMaintainer")
  • name string (default: "")
  • email string nullable
  • url string nullable
• contributors array (default: [])
  • @type string (default: "NpmMaintainer")
  • name string (default: "")
  • email string nullable
  • url string nullable
• dist_tags object (default: {})
  • * string
• tarball string nullable
• shasum string nullable
• integrity string nullable
• file_count integer (default: 0)
• unpacked_size integer (default: 0)
• engines object (default: {})
  • * string
• dependencies object (default: {})
  • * string
• dependency_count integer (default: 0)
• peer_dependencies object (default: {})
  • * string
• peer_dependency_count integer (default: 0)
• is_deprecated boolean (default: false)
• deprecated_reason string nullable
• star_count integer (default: 0)
• version_count integer (default: 0)
• versions array (default: [])
  • @type string (default: "NpmPackageVersion")
  • version string required
  • published_at string (default: "")
• created_at string (default: "")
• modified_at string (default: "")
• readme_filename string nullable
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Package not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.