Search Library

Search available libraries

Search Library

Search across available libraries. Returns finalized public libraries and accessible private repositories based on authentication.

Arguments

query · string · required

The search query to find libraries

Response

SearchLibraryResponse · object

Show properties

results · SearchResult[] · required

Array of library search results

Show SearchResult properties

id · string · required

Unique identifier for the library (e.g., “/facebook/react”)

title · string · required

Display name of the library

description · string · required

Brief description of the library

branch · string · required

Default branch name

lastUpdateDate · string · required

ISO 8601 timestamp of last update

state · 'initial' | 'finalized' | 'processing' | 'error' | 'delete' · required

Current processing state of the library

totalTokens · number · required

Total number of tokens in documentation

totalSnippets · number · required

Total number of code snippets

stars · number

Number of GitHub stars

trustScore · number

Trust score of the library

benchmarkScore · number

Benchmark score

versions · string[]

Available versions

metadata · APIResponseMetadata · required

Show properties

authentication · 'none' | 'personal' | 'team' · required

Authentication level used for the request

Examples

Basic Search

import { Context7 } from "@upstash/context7-sdk";

const client = new Context7();

const response = await client.searchLibrary("react");

console.log(`Found ${response.results.length} libraries`);
response.results.forEach(library => {
console.log(`${library.title}: ${library.description}`);
});

Use Cases

Finding Popular Libraries

const response = await client.searchLibrary("react");

// Sort by stars
const popular = response.results
  .filter((lib) => lib.stars !== undefined)
  .sort((a, b) => (b.stars || 0) - (a.stars || 0));

console.log("Most popular:", popular[0].title);

Checking Documentation Availability

const response = await client.searchLibrary("axios");

response.results.forEach((lib) => {
  console.log(`${lib.title}:`);
  console.log(`  - State: ${lib.state}`);
  console.log(`  - Snippets: ${lib.totalSnippets}`);
  console.log(`  - Tokens: ${lib.totalTokens}`);
});

Getting Library Versions

const response = await client.searchLibrary("lodash");

const library = response.results[0];
if (library.versions) {
  console.log(`Available versions: ${library.versions.join(", ")}`);
}