> ## Documentation Index
> Fetch the complete documentation index at: https://context7.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Library

> Search available libraries

# Search Library

Search across available libraries. Returns an array of matching libraries with metadata useful for selection.

## Arguments

**query** `string` *required*

The user's question or task (used for relevance ranking)

**libraryName** `string` *required*

The library name to search for

**options** `SearchLibraryOptions`

**properties**

**type** `'json' | 'txt'`

Format of the response. Defaults to `json`.

**signal** `AbortSignal`

Abort signal for cancelling this request.

**timeout** `number | false`

Per-request timeout in milliseconds. Use `false` to disable the client timeout.

**cache** `CacheSetting`

Native fetch cache mode. Use `false` to omit the cache option.

## Response

Returns `Library[]` - an array of library objects.

**Library** `object`

**properties**

**id** `string` *required*

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

**name** `string` *required*

Display name of the library

**description** `string` *required*

Brief description of the library

**totalSnippets** `number` *required*

Total number of documentation snippets available

**trustScore** `number` *required*

Trust score of the library

**benchmarkScore** `number` *required*

Benchmark score indicating documentation quality

**versions** `string[]`

Available versions

## Examples

```typescript Basic Search theme={null}
import { Context7 } from "@upstash/context7-sdk";

const client = new Context7();

const libraries = await client.searchLibrary(
  "I need to build a UI",
  "react"
);

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

```typescript Selecting Best Library theme={null}
import { Context7 } from "@upstash/context7-sdk";

const client = new Context7();

const libraries = await client.searchLibrary(
  "I want to build a web app",
  "next"
);

const sorted = libraries.sort((a, b) => b.benchmarkScore - a.benchmarkScore);
const best = sorted[0];

console.log(`Best match: ${best.name} (score: ${best.benchmarkScore})`);
console.log(`Available snippets: ${best.totalSnippets}`);
```

```typescript Error Handling theme={null}
import { Context7, Context7Error } from "@upstash/context7-sdk";

const client = new Context7();

try {
  const libraries = await client.searchLibrary("query", "express");

  if (libraries.length === 0) {
    console.log("No libraries found");
  } else {
    console.log(`Found ${libraries.length} libraries`);
  }
} catch (error) {
  if (error instanceof Context7Error) {
    console.error("API Error:", error.message);
  } else {
    throw error;
  }
}
```

## Use Cases

### Finding Libraries by Score

```typescript theme={null}
const libraries = await client.searchLibrary("state management", "redux");

const trusted = libraries.sort((a, b) => b.trustScore - a.trustScore);
console.log("Most trusted:", trusted[0].name);
```

### Checking Available Versions

```typescript theme={null}
const libraries = await client.searchLibrary("I want to use lodash", "lodash");

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

### Full Workflow

```typescript theme={null}
import { Context7 } from "@upstash/context7-sdk";

const client = new Context7();

const libraries = await client.searchLibrary(
  "I want to build a React app",
  "react"
);

const library = libraries[0];
console.log(`Using: ${library.name} (${library.id})`);

const context = await client.getContext(
  "How do I create a component?",
  library.id
);

console.log(context);
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.