LIlinuxfoundation
Packages

Get full package detail

Changed on

Returns data for the drawer's Overview, Security, and Provenance tabs. Pass the canonical purl as a query parameter — no URL-encoding needed. Example: ?purl=pkg:npm/lodash@4.17.21.

get/packages/detail

Request

  • Base URL
    https://cm.lfx.dev/api/v1
  • URL
    https://cm.lfx.dev/api/v1/packages/detail
  • Auth
    HTTP bearer

Query parameters

purlstring required

Response

Package found.

purlstring required
namestring required
ecosystemstring required
assessmentobject required

Stewardship assessment data. Empty in v1 — assessment flow deferred to v2.

historyobject required

Package history data. Empty in v1.

signalCoverageHealthobject nullable

Signal coverage health data enriched by Tinybird. Null until enriched.

Example response

{
  "purl": "pkg:npm/lodash",
  "name": "lodash",
  "ecosystem": "npm",
  "general": {
    "healthScore": 18,
    "healthScoreDetails": {
      "total": 18,
      "label": "Good",
      "maintainerHealth": 4,
      "securitySupplyChain": 8,
      "developmentActivity": 6
    },
    "healthBand": "concerning",
    "impact": {
      "impactScore": 71,
      "downloadsLastMonth": 52142891,
      "dependentPackages": 142312,
      "dependentRepos": 39104,
      "transitiveReach": "Top 0.4%"
    },
    "riskSignals": {
      "maintainerBusFactor": 1,
      "openSSFScorecard": 5.2
    }
  },
  "security": {
    "advisories": [
      {
        "osvId": "CVE-2021-44906"
      }
    ]
  },
  "provenance": {
    "repositoryMapping": {
      "declaredRepo": "https://github.com/lodash/lodash",
      "mappingConfidence": 0.98
    }
  },
  "stewardship": {
    "id": "42",
    "stewards": [
      {
        "userId": "abc123",
        "username": "jrodriguez",
        "displayName": "Jonathan R."
      }
    ]
  }
}

Changes

  • v136d7585ff64cRevision changes
    • warning

      added the new archived enum value to the // response property for the response status

    • warning

      added the new excellent enum value to the / response property for the response status

  • v1b1ac806083eeRevision changes
    • breaking

      the / response's property type changed from object null to integer null for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status