CompatLab Search API

The Search API from CompatLab — 1 operation(s) for search.

GitHub OpenAPI

Operations 1

GET /api/v1/search Search npm package metadata (up to 10 results) #

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-search-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-search-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compatlab Me Search API
  version: '1'
  description: 'Operations tagged Search 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: Search
paths:
  /api/v1/search:
    get:
      operationId: searchPackages
      summary: Search npm package metadata (up to 10 results)
      parameters:
      - name: q
        in: query
        required: true
        description: Package name or search text.
        schema:
          type: string
          minLength: 1
          maxLength: 200
      responses:
        '200':
          description: Public result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
        '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:
      - Search
    servers:
    - url: https://compatlab.me
components:
  schemas:
    SearchResponse:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        schemaVersion:
          type: number
          const: 1
        packages:
          maxItems: 20
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                maxLength: 214
              version:
                type: string
                maxLength: 256
              description:
                type: string
                maxLength: 4096
              repositoryUrl:
                type: string
                maxLength: 2048
                format: uri
              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'
            required:
            - name
            - version
            - reportId
            additionalProperties: false
      required:
      - schemaVersion
      - packages
      additionalProperties: false
externalDocs:
  url: https://compatlab.me/api
x-refined-from:
- compatlab-me-openapi.json
- compatlab-me-openapi.yml