docs / enrich-package

Package & Dependency Trust API

Package & Dependency Trust API

base /enrich-package/v14 endpoints
post/enrich-package/v1/package_trust3 credits

ecosystem+package → registry metadata + downloads + maintainers + license + resolved repository health + vulnerabilities + partial trust score (with per-sub-score inputs)

ParameterAllowed / rangeDescription
ecosystemrequirednpm · pypi · maven · rubygems · crates · goPackage ecosystem. npm/pypi get full registry metadata + downloads; maven/rubygems/crates/go get vulnerabilities + declared-repository health (the wider OSV ecosystem set).
packagerequiredPackage name as published in its registry (npm 'lodash', PyPI 'requests', Maven 'group:artifact', Go import path). Scoped npm names like '@scope/pkg' are supported.
versionoptionalExact installed version to assess for vulnerabilities. Omit to assess the latest published version + ALL known vulns of the package.
mode = richoptionalbasic · richbasic = registry metadata + license + repo health + score; rich (default) adds the full vulnerability scan, release cadence, contributor bus-factor and a stackoverflow community signal.
Try in playground →
post/enrich-package/v1/repo_trust3 credits

owner/repo → repository health + release cadence + bus-factor signal + repo-anchored trust sub-scores (popularity/maintenance), independent of any registry

ParameterAllowed / rangeDescription
ownerrequiredGitHub repository owner / org (e.g. 'facebook').
reporequiredGitHub repository name (e.g. 'react').
Try in playground →
post/enrich-package/v1/lockfile_scan5 credits

manifest/lockfile text → dependency list + each dep's vuln/risk summary via one batched vuln scan (BOUNDED: direct + lockfile-pinned deps, max 100; truncated:true when capped). package.json/lock, requirements.txt, go.sum/mod, Cargo.lock, Gemfile.lock

ParameterAllowed / rangeDescription
contentrequiredRaw manifest/lockfile text: package.json, package-lock.json, requirements.txt, go.sum/go.mod, Cargo.lock, or Gemfile.lock. Direct (+ lockfile-pinned) deps are scanned; bounded to 100 deps.
filenameoptionalOptional filename hint to disambiguate the manifest format (e.g. 'package-lock.json', 'go.sum'). Auto-detected if omitted.
ecosystemoptionalnpm · pypi · maven · rubygems · crates · goOptional ecosystem hint when the manifest format is ambiguous.
Try in playground →
post/enrich-package/v1/batch2 credits

trust-score up to 10 packages in one call (basic depth, per-item ok/error)

ParameterAllowed / rangeDescription
itemsrequiredUp to 10 {ecosystem, package, version?} objects. Each is trust-scored like package_trust (basic depth); per-item ok/error.
Try in playground →