Skip to main content
GET
Check a package
The report combines malware and vulnerability advisories, registry reputation, typosquatting checks, and a scan of the published artifact for code that runs on install or at Python startup.

Path parameters

Query parameters

Example

A removed malicious version

npm and PyPI delete malware after it is reported, but lockfiles and caches keep the version. If OSV lists a deleted package or version as malicious, the API returns a report instead of a 404:

A malicious package

Response

Finding

Vulnerability

Package

Artifact

The API downloads the published package and inspects code that runs without being imported, such as npm install scripts and Python startup files.

Verdicts

Verdicts do not consider vulnerabilities. Use risk or the vulnerabilities array for those.

Errors

See Errors for the response format.

Path Parameters

ecosystem
enum<string>
required
Available options:
npm,
pypi
name
string
required

Package name. Scoped npm names may contain a literal or encoded slash.

Query Parameters

version
string
Maximum string length: 128

Response

Risk report

ecosystem
enum<string>
required
Available options:
npm,
pypi
name
string
required
version
string
required
verdict
enum<string>
required
Available options:
malicious,
suspicious,
review,
ok
risk
enum<string>
required
Available options:
critical,
high,
medium,
low,
none
findings
object[]
required
vulnerabilities
object[]
required
package
object
required
checked_at
string<date-time>
required