CompatLab Packages API

The Packages API from CompatLab — 1 operation(s) for packages.

GitHub OpenAPI

Operations 1

GET /api/v1/packages Resolve a package version and find existing evidence #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/compatlab-me:compatlab-me-packages-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

compatlab-me-packages-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compatlab Me Packages API
  version: '1'
  description: 'Operations tagged Packages across 2 of this provider''s published API definitions: compatlab-me-openapi.json, compatlab-me-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://compatlab.me
security: []
tags:
- name: Packages
paths:
  /api/v1/packages:
    get:
      operationId: getPackage
      summary: Resolve a package version and find existing evidence
      description: reportId selects baseline evidence for the current matrix and classifier. availableReport also exposes eligible baseline evidence from another approved matrix, with matchesCurrentMatrix=false and the original observation time. An active scan can coexist with either result. No read starts work.
      parameters:
      - name: name
        in: query
        required: true
        description: Exact npm package name, including its scope when present.
        schema:
          type: string
          minLength: 1
          maxLength: 214
      - name: version
        in: query
        required: false
        description: Exact published version. Omit to resolve the latest tag; tags and ranges are not accepted as version values.
        schema:
          type: string
          minLength: 1
          maxLength: 256
      responses:
        '200':
          description: Public result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackageResponse'
        '400':
          description: Invalid query or identifier.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '404':
          description: Package, version or report not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '503':
          description: Service busy or upstream unavailable. Retry with backoff.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
          headers:
            Retry-After:
              description: When supplied, seconds before retrying.
              schema:
                type: string
      tags:
      - Packages
    servers:
    - url: https://compatlab.me
components:
  schemas:
    PackageResponse:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        schemaVersion:
          type: number
          const: 1
        name:
          type: string
        version:
          type: string
        description:
          type: string
        deprecated:
          type:
          - string
          - 'null'
        repositoryUrl:
          anyOf:
          - type: string
            format: uri
          - type: 'null'
        versions:
          maxItems: 200
          type: array
          items:
            type: string
        versionsTruncated:
          type: boolean
        tags:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: string
        reportId:
          anyOf:
          - type: string
            format: uuid
            pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          - type: 'null'
        availableReport:
          anyOf:
          - type: object
            properties:
              id:
                type: string
                format: uuid
                pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
              observedAt:
                anyOf:
                - type: string
                  format: date-time
                  pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                - type: 'null'
              classifierRevision:
                type: string
                minLength: 1
                maxLength: 128
              outcome:
                type: string
                enum:
                - pass
                - partial
                - fail
                - inconclusive
                - unsupported
                - not_applicable
                - infrastructure_error
              coverageComplete:
                type: boolean
              matchesCurrentMatrix:
                type: boolean
              matrix:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  revision:
                    type: string
                    maxLength: 128
                  platform:
                    type: string
                    const: linux_amd64_glibc
                required:
                - id
                - revision
                - platform
                additionalProperties: false
            required:
            - id
            - observedAt
            - classifierRevision
            - outcome
            - coverageComplete
            - matchesCurrentMatrix
            - matrix
            additionalProperties: false
          - type: 'null'
        scanId:
          anyOf:
          - type: string
            format: uuid
            pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          - type: 'null'
        scansEnabled:
          type: boolean
      required:
      - schemaVersion
      - name
      - version
      - description
      - deprecated
      - repositoryUrl
      - versions
      - versionsTruncated
      - tags
      - reportId
      - scanId
      - scansEnabled
      additionalProperties: false
externalDocs:
  url: https://compatlab.me/api
x-refined-from:
- compatlab-me-openapi.json
- compatlab-me-openapi.yml