AIaikido

Get package health scores

Returns a health score and summary for each requested package version that has been scored. Packages must use the name@version format. Maven package names must include the group and artifact IDs, for example org.springframework:spring-core@6.2.3. Packages without a score are not included. A missing result does not mean that the package or version does not exist.

get/research/package-health/bulk

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/research/package-health/bulk
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: research:read

Query parameters

ecosystem'cargo' | 'clawhub' | 'cpan' | 'chrome' | 'cocoapods' | 'drupal_packagist' | 'eclipse' | 'edge' | 'firefox' | 'github' | 'github_actions' | 'golang' | 'hex' | 'homebrew' | 'huggingface' | 'jetbrains' | 'maven' | 'npm' | 'nuget' | 'open_vsx' | 'packagist' | 'powershell_gallery' | 'pub' | 'pypi' | 'ruby' | 'skills_sh' | 'snyk' | 'swift' | 'terraform' | 'vscode' | 'visual_studio' | 'webpage' | 'wordpress' required

The ecosystem of the packages to look up. All packages in the request must belong to this ecosystem.

packagesstring required

Comma-separated list of package versions in name@version format. For Maven packages, use group:artifact@version. You can request up to 100 package versions at a time. If the request URL becomes too long, split the list across multiple requests.

Response

An array of package health entries

namestring required

The name of the package

versionstring required

The version of the package

ecosystemstring required

The ecosystem of the package

Example response

[
  {
    "name": "express",
    "version": "2.2.1",
    "ecosystem": "npm",
    "health": {
      "score": 80,
      "summary": "Actively maintained package with a healthy release cadence."
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.