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

# SDK

Install the Channel3 SDK, authenticate, and make async calls.

## Installation

```typescript TypeScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
// npm
npm install @channel3/sdk

// yarn
yarn add @channel3/sdk

// pnpm
pnpm add @channel3/sdk
```

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# pip
pip install channel3-sdk

# uv
uv add channel3-sdk
```

## Authentication

Provide your API key via the `CHANNEL3_API_KEY` environment variable, or pass it directly to the client.

```typescript TypeScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
import Channel3 from "@channel3/sdk";

// Initialize with environment variable
const client = new Channel3();

// Or, initialize with API key directly
const clientWithKey = new Channel3({
  apiKey: "your_api_key_here",
});
```

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
from channel3_sdk import Channel3

# Initialize with environment variable
client = Channel3()

# Or, initialize with API key directly
client_with_key = Channel3(api_key="your_api_key_here")
```

## Async usage

```typescript TypeScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
import Channel3 from "@channel3/sdk";

const client = new Channel3();

async function main() {
  const response = await client.products.search({
    query: "organic cotton t-shirt",
  });
  console.log(response);
}

main();
```

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
import asyncio
from channel3_sdk import AsyncChannel3

client = AsyncChannel3()

async def main():
    response = await client.products.search(
        query="organic cotton t-shirt"
    )
    print(response)

if __name__ == "__main__":
    asyncio.run(main())
```

## Explore the SDK

> **[Search](/sdk/keyword-search)**
>
> Keyword, image, similar-product, filtered, and paginated search.

> **[Brands](/sdk/find-brands)**
>
> Find a brand, browse the catalog, and use brand filters.

> **[Websites](/sdk/websites)**
>
> List retailers and limit search to their offers.

> **[Categories](/sdk/find-categories)**
>
> Find categories and apply a category filter.

> **[Product lookup](/sdk/lookup-by-url)**
>
> Resolve a retailer URL to a canonical product.

> **[Error handling](/sdk/error-handling)**
>
> Handle SDK request and API errors.


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