Get package verdict
Returns a fast dependency verdict for a single package. GitHub Action scans use it to flag known-malicious dependencies. The package version is a query parameter.
For scoped npm packages, such as @scope/name, use GET /hfw/verdict/{ecosystem}/{scope}/{packageName} instead.
This is a public, fast-mode endpoint. It covers feed-backed verdicts only and normally returns straight away. To wait briefly for an upstream verdict, set wait_seconds. It may move behind the X-Api-Key header later.
Request
GET /hfw/verdict/{ecosystem}/{packageName}
This endpoint takes no API key.
Path parameters
| Parameter | Description |
|---|---|
ecosystemstring, required | One of npm or pypi. |
packageNamestring, required |
Query parameters
| Parameter | Description |
|---|---|
versionstring, required | Package version to check. |
wait_secondsnumber | Seconds to wait for an upstream verdict. Fast mode normally returns immediately. Default 0. At least 0. At most 8. |
Responses
200 OK
| Field | Description |
|---|---|
statusstring, required | One of ready, pending, or scanning. |
ecosystemstring, required | One of npm or pypi. |
packagestring, required | |
versionstring, required | |
levelstring, required | One of clean, suspicious, malicious, or unknown. |
confidencestring, required | |
summarystring, required | |
findingsarray of object, required | |
sourcestring | |
osv_idstring |