Channel3

https://docs.trychannel3.com
Admin
Channel3 is building a database of every product on the internet. Developers use the Channel3 API to...
Tokens:54,988
Snippets:524
Trust Score:6.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Price History (Go)

Source: https://docs.trychannel3.com/api-reference/price-tracking/get-price-history

Use the Channel3 Go SDK to get price history for a product. This example demonstrates client initialization with an API key and making the API call.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	priceHistory, err := client.PriceTracking.GetHistory(
		context.TODO(),
		"canonical_product_id",
		channel3go.PriceTrackingGetHistoryParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", priceHistory.CanonicalProductID)
}

```

--------------------------------

### Start Tracking with Go SDK

Source: https://docs.trychannel3.com/api-reference/price-tracking/start-tracking

Use the Go SDK to start tracking prices. Provide your API key and the canonical product ID.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	subscription, err := client.PriceTracking.Start(context.TODO(), channel3go.PriceTrackingStartParams{
		StartTrackingRequest: channel3go.StartTrackingRequestParam{
			CanonicalProductID: "canonical_product_id",
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", subscription.CanonicalProductID)
}

```

--------------------------------

### Search Products (Go)

Source: https://docs.trychannel3.com/api-reference/v1/search

Implement product search with the Go SDK. This example demonstrates client initialization and making a search request.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Products.Search(context.TODO(), channel3go.ProductSearchParams{
		SearchRequest: channel3go.SearchRequestParam{},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

```

--------------------------------

### Start Tracking with CLI

Source: https://docs.trychannel3.com/api-reference/price-tracking/start-tracking

Initiate price tracking via the command-line interface. Requires an API key and the canonical product ID.

```CLI
channel3 price-tracking start \
  --api-key 'My API Key' \
  --canonical-product-id canonical_product_id
```

--------------------------------

### Install Channel3 SDK

Source: https://docs.trychannel3.com/sdk

Install the Channel3 SDK using npm, yarn, pnpm for TypeScript or pip, uv for Python.

```typescript
// npm
npm install @channel3/sdk

// yarn
yarn add @channel3/sdk

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

```python
# pip
pip install channel3-sdk

# uv
uv add channel3-sdk
```

--------------------------------

### Install Product Discovery Skill

Source: https://docs.trychannel3.com/skills

Install the product discovery skill for your agent. This skill allows agents to search and compare products directly within a conversation.

```bash
npx skills add channel3-ai/skills --skill product-discovery
```

--------------------------------

### Quick Start MCP URL

Source: https://docs.trychannel3.com/mcp-overview

Connect directly to the MCP without an API key for the free tier.

```url
https://mcp.trychannel3.com/
```

--------------------------------

### Get Price History (CLI)

Source: https://docs.trychannel3.com/api-reference/price-tracking/get-price-history

Example of how to retrieve price history using the command-line interface.

```CLI

```

--------------------------------

### Install Channel3 CLI with Homebrew

Source: https://docs.trychannel3.com/cli

Use this command to install the Channel3 CLI using the Homebrew package manager.

```sh
brew install channel3-ai/tap/channel3
```

--------------------------------

### Search for Products using Channel3 CLI

Source: https://docs.trychannel3.com/cli

Example of searching for products using the Channel3 CLI, specifying a query.

```sh
channel3 products search --query "organic cotton t-shirt"
```

--------------------------------

### Start Tracking with JavaScript SDK

Source: https://docs.trychannel3.com/api-reference/price-tracking/start-tracking

Use the JavaScript SDK to initiate price tracking for a canonical product. Ensure your API key is set.

```JavaScript
import Channel3 from '@channel3/sdk';

const client = new Channel3({
  apiKey: process.env['CHANNEL3_API_KEY'], // This is the default and can be omitted
});

const subscription = await client.priceTracking.start({
  canonical_product_id: 'canonical_product_id',
});

console.log(subscription.canonical_product_id);
```

--------------------------------

### List Categories with Go SDK

Source: https://docs.trychannel3.com/api-reference/v1/list-categories

Use the Go SDK to list categories. This example demonstrates basic client initialization and calling the list method.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Categories.List(context.TODO(), channel3go.CategoryListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

```

--------------------------------

### Start Tracking with Python SDK

Source: https://docs.trychannel3.com/api-reference/price-tracking/start-tracking

Initiate price tracking using the Python SDK. The API key can be provided via environment variable.

```Python
import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
subscription = client.price_tracking.start(
    canonical_product_id="canonical_product_id",
)
print(subscription.canonical_product_id)
```

--------------------------------

### Install MCP in Cursor

Source: https://docs.trychannel3.com/mcp-overview

Manually add the MCP configuration to your Cursor setup.

```json
{
  "mcpServers": {
    "Channel3": {
      "url": "https://mcp.trychannel3.com/"
    }
  }
}
```

--------------------------------

### Search Products (Python)

Source: https://docs.trychannel3.com/api-reference/v1/search

Integrate product search using the Python SDK. This example shows how to retrieve the first product's ID.

```Python
import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
page = client.products.search()
page = page.products[0]
print(page.id)
```

--------------------------------

### Start Tracking

Source: https://docs.trychannel3.com/api-reference/price-tracking/start-tracking

Initiates price tracking for a specified canonical product. Requires a valid API key and the canonical product ID.

```APIDOC
## POST /v0/price-tracking/start

### Description
Start tracking prices for a canonical product.

### Method
POST

### Endpoint
/v0/price-tracking/start

### Parameters
#### Request Body
- **canonical_product_id** (string) - Required - The unique identifier for the canonical product.

### Request Example
```json
{
  "canonical_product_id": "canonical_product_id"
}
```

### Response
#### Success Response (200)
- **canonical_product_id** (string) - The canonical product ID for which tracking has started.

#### Response Example
```json
{
  "canonical_product_id": "canonical_product_id"
}
```

### Error Handling
- **401 Unauthorized**: Invalid or missing authentication.
- **402 Payment Required**: Free credits exhausted.
- **404 Not Found**: Canonical product does not exist.
- **422 Unprocessable Entity**: Validation error, likely a missing required field.
- **500 Internal Server Error**: An unexpected server error occurred.
```

--------------------------------

### Search by Image (Go)

Source: https://docs.trychannel3.com/api-reference/v1/image-search

Implement image search using the Go SDK. This example demonstrates client initialization with an API key and making the search request. Error handling is included.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Products.SearchByImage(context.TODO(), channel3go.ProductSearchByImageParams{
		ImageSearchRequest: channel3go.ImageSearchRequestParam{},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}
```

--------------------------------

### Install MCP in VS Code

Source: https://docs.trychannel3.com/mcp-overview

Manually add the MCP configuration to your VS Code setup.

```json
{
  "servers": {
    "Channel3": {
      "type": "http",
      "url": "https://mcp.trychannel3.com/"
    }
  }
}
```

--------------------------------

### Install Channel3 API Skill

Source: https://docs.trychannel3.com/quickstart

Install the Channel3 API skill using npm. This command adds the necessary skill for your AI coding agent to interact with Channel3.

```bash
npx skills add channel3-ai/skills --skill channel3-api
```

--------------------------------

### Start Tracking

Source: https://docs.trychannel3.com/api-reference/price-tracking/start-tracking

Initiates price tracking for a specific product. This endpoint requires an API key for authentication and accepts the canonical product ID in the request body.

```APIDOC
## POST /websites/trychannel3/price-tracking

### Description
Starts price tracking for a given product.

### Method
POST

### Endpoint
/websites/trychannel3/price-tracking

### Request Body
- **canonical_product_id** (string) - Required - The unique identifier for the product to track.

### Request Example
{
  "canonical_product_id": "example_product_id"
}

### Response
#### Success Response (200)
- **canonical_product_id** (string) - The unique identifier for the product.
- **subscription_status** (SubscriptionStatus) - The current status of the subscription (active or cancelled).
- **created_at** (string) - The date and time when the subscription was created.

#### Response Example
{
  "canonical_product_id": "example_product_id",
  "subscription_status": "active",
  "created_at": "2023-10-27T10:00:00Z"
}

### Error Handling
#### Error Response
- **detail** (string or array) - Provides details about the error that occurred.

#### Error Response Example
{
  "detail": "Invalid product ID"
}
```

--------------------------------

### Retrieve Website Information (CLI)

Source: https://docs.trychannel3.com/api-reference/channel3-api/websites

Command-line interface example for retrieving website information using the Channel3 CLI tool. This requires specifying the API key and the query parameter.

```bash
channel3 websites retrieve \
  --api-key 'My API Key' \
  --query query
```

--------------------------------

### Prompt to Use Channel3 API Skill

Source: https://docs.trychannel3.com/skills

Use this prompt to instruct your agent to integrate Channel3 into a project using the Channel3 API skill. Ensure the skill is installed first.

```text
Help me integrate Channel3 into my project using the Channel3 API skill.
```

--------------------------------

### Find Similar Products (Go)

Source: https://docs.trychannel3.com/api-reference/v1/similar-products

Use the Go SDK to find similar products. Provide your API key during client initialization.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Products.FindSimilar(context.TODO(), channel3go.ProductFindSimilarParams{
		SimilarProductsRequest: channel3go.SimilarProductsRequestParam{
			ProductID: "product_id",
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

```

--------------------------------

### Get Similar Products

Source: https://docs.trychannel3.com/api-reference/v1/similar-products

Retrieves a list of products that are similar to the specified product. This endpoint is useful for recommendations and cross-selling.

```APIDOC
## GET /v1/similar-products

### Description
Retrieves a list of products that are similar to the specified product. This endpoint is useful for recommendations and cross-selling.

### Method
GET

### Endpoint
/v1/similar-products

### Parameters
#### Query Parameters
- **product_id** (string) - Required - The ID of the product for which to find similar items.
- **limit** (integer) - Optional - The maximum number of similar products to return.
- **offset** (integer) - Optional - The number of similar products to skip before returning results.

### Response
#### Success Response (200)
- **products** (array) - A list of similar product objects.
  - **id** (string) - The unique identifier of the similar product.
  - **name** (string) - The name of the similar product.
  - **thumbnail_url** (string) - The URL of the thumbnail image for the similar product.
  - **score** (number) - The similarity score between the requested product and this similar product.

#### Response Example
{
  "products": [
    {
      "id": "prod_12345",
      "name": "Another Great Product",
      "thumbnail_url": "https://example.com/images/prod_12345.jpg",
      "score": 0.85
    },
    {
      "id": "prod_67890",
      "name": "Yet Another Product",
      "thumbnail_url": "https://example.com/images/prod_67890.jpg",
      "score": 0.72
    }
  ]
}
```

--------------------------------

### Get Similar Products

Source: https://docs.trychannel3.com/api-reference/v1/similar-products

Retrieves a list of products that are similar to a given product. This is useful for cross-selling and up-selling recommendations.

```APIDOC
## GET /v1/similar-products

### Description
Retrieves a list of products that are similar to a given product. This is useful for cross-selling and up-selling recommendations.

### Method
GET

### Endpoint
/v1/similar-products

### Parameters
#### Query Parameters
- **product_id** (string) - Required - The unique identifier of the product for which to find similar items.
- **limit** (integer) - Optional - The maximum number of similar products to return. Defaults to 10.

### Response
#### Success Response (200)
- **products** (array) - A list of similar product objects.
  - Each product object contains details such as `id`, `title`, `url`, `price`, and `image_url`.

#### Response Example
```json
{
  "products": [
    {
      "id": "prod_12345",
      "title": "Example Similar Product 1",
      "url": "https://example.com/product/12345",
      "price": {
        "price": 49.99,
        "currency": "USD"
      },
      "image_url": "https://example.com/images/prod_12345.jpg"
    },
    {
      "id": "prod_67890",
      "title": "Example Similar Product 2",
      "url": "https://example.com/product/67890",
      "price": {
        "price": 59.99,
        "currency": "USD"
      },
      "image_url": "https://example.com/images/prod_67890.jpg"
    }
  ]
}
```
```

--------------------------------

### Upgrade Channel3 CLI with Homebrew

Source: https://docs.trychannel3.com/cli

Use this command to upgrade an existing Channel3 CLI installation to the latest version via Homebrew.

```sh
brew upgrade channel3
```

--------------------------------

### List Brands (Go)

Source: https://docs.trychannel3.com/api-reference/v1/list-brands

Use the Go SDK to list brands. Initialize the client with an API key and call the List method.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.Brands.List(context.TODO(), channel3go.BrandListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

```

--------------------------------

### Retrieve Product Detail (Python)

Source: https://docs.trychannel3.com/api-reference/v1/product-detail

Utilize the Channel3 SDK for Python to fetch product information. The API key should be configured via environment variables.

```Python
import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
product_detail = client.products.retrieve(
    product_id="product_id",
)
print(product_detail.id)
```

--------------------------------

### Find Similar Products (CLI)

Source: https://docs.trychannel3.com/api-reference/v1/similar-products

Use the Channel3 CLI to find similar products. Pass your API key and the product ID as arguments.

```CLI
channel3 products find-similar \
  --api-key 'My API Key' \
  --product-id product_id
```

--------------------------------

### Initialize Channel3 Client

Source: https://docs.trychannel3.com/variants

Instantiate the Channel3 client with your API key to begin making requests.

```Python
from channel3 import Channel3

client = Channel3(api_key="YOUR_API_KEY")

```

--------------------------------

### Find Similar Products (Python)

Source: https://docs.trychannel3.com/api-reference/v1/similar-products

Use the Python SDK to find similar products. Ensure your API key is set as an environment variable.

```Python
import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
page = client.products.find_similar(
    product_id="product_id",
)
page = page.products[0]
print(page.id)
```

--------------------------------

### Get Category Detail

Source: https://docs.trychannel3.com/api-reference/v1/category-detail

Look up a category by its unique slug. This endpoint returns comprehensive details about the category, including its title, path, and child status.

```APIDOC
## GET /v1/categories/{slug}

### Description
Look up a category by slug. This endpoint returns detailed information about a specific category.

### Method
GET

### Endpoint
/v1/categories/{slug}

### Parameters
#### Path Parameters
- **slug** (string) - Required - The unique slug of the category to retrieve.

### Request Example
```json
{
  "example": "No request body needed for GET request"
}
```

### Response
#### Success Response (200)
- **slug** (string) - URL-friendly slug (e.g. 'sofas').
- **title** (string) - Human-readable category title.
- **path** (array) - Hierarchical path as a structured list, root first; the last entry is this category itself.
- **has_children** (boolean) - Indicates if the category has sub-categories.

#### Response Example
```json
{
  "slug": "electronics",
  "title": "Electronics",
  "path": [
    {
      "slug": "all",
      "title": "All Products"
    },
    {
      "slug": "electronics",
      "title": "Electronics"
    }
  ],
  "has_children": true
}
```

#### Error Responses
- **401 Unauthorized** - Invalid or missing authentication token.
- **402 Payment Required** - Free credits exhausted, payment method needed.
- **404 Not Found** - No category found matching the provided slug.
- **422 Unprocessable Entity** - Validation error, likely with input parameters.
- **500 Internal Server Error** - An unexpected server error occurred.
```

--------------------------------

### Lookup Product via CLI

Source: https://docs.trychannel3.com/api-reference/v1/lookup-product

Perform a product lookup directly from the command line interface. Specify the API key and the product URL.

```CLI
channel3 products lookup \
  --api-key 'My API Key' \
  --url url
```

--------------------------------

### Get Price History

Source: https://docs.trychannel3.com/api-reference/price-tracking/get-price-history

Fetches the price history for a given canonical product ID. Supports specifying the number of days for the history, defaulting to 30 days.

```APIDOC
## GET /v0/price-tracking/history/{canonical_product_id}

### Description
Get price history for a canonical product.

### Method
GET

### Endpoint
/v0/price-tracking/history/{canonical_product_id}

### Parameters
#### Path Parameters
- **canonical_product_id** (string) - Required - The unique identifier for the product.

#### Query Parameters
- **days** (integer) - Optional - Number of days of history to fetch (max 30). Defaults to 30.

### Responses
#### Success Response (200)
- **canonical_product_id** (string) - The canonical ID of the product.
- **prices** (array) - A list of price points.
  - **timestamp** (string) - The time the price was recorded.
  - **price** (number) - The price of the product at that timestamp.

#### Error Responses
- **401** Unauthorized - Invalid or missing authentication.
- **402** Payment Required - Free credits exhausted.
- **404** Not Found - Canonical product not found.
- **422** Validation Error - Invalid input parameters.
- **500** Internal Server Error - Server encountered an error.
```

--------------------------------

### List Brands (CLI)

Source: https://docs.trychannel3.com/api-reference/v1/list-brands

Use the Channel3 CLI to list brands. Ensure you provide your API key.

```bash
channel3 brands list \
  --api-key 'My API Key'
```

--------------------------------

### Get Similar Products

Source: https://docs.trychannel3.com/api-reference/v1/similar-products

Retrieves a list of products that are similar to a given product ID. This endpoint allows filtering by various attributes to refine the search for similar items.

```APIDOC
## GET /v1/similar-products

### Description
Retrieves a list of products that are similar to a given product ID. This endpoint allows filtering by various attributes to refine the search for similar items.

### Method
GET

### Endpoint
/v1/similar-products

### Parameters
#### Query Parameters
- **id** (string) - Required - The unique identifier of the product for which to find similar items.
- **gender** (string) - Optional - Filters results by gender. Allowed values: 'male', 'female', 'unisex'.
- **age** (string) - Optional - Filters results by target age group. Allowed values: 'newborn', 'infant', 'toddler', 'kids', 'adult'.
- **materials** (array of strings) - Optional - Filters results by materials. 
- **key_features** (array of strings) - Optional - Filters results by key features.
- **min_price** (number) - Optional - Minimum price filter (inclusive).
- **max_price** (number) - Optional - Maximum price filter (inclusive).
- **availability_status** (string) - Optional - Filters results by availability status. Allowed values: 'InStock', 'LimitedAvailability', 'PreOrder', 'BackOrder', 'SoldOut', 'OutOfStock', 'Discontinued', 'Unknown'.
- **colors_palette** (array of strings) - Optional - Filters results by color palette. Treated as an AND condition.

### Response
#### Success Response (200)
- **products** (array of Product) - A list of similar products.

#### Response Example
{
  "products": [
    {
      "id": "string",
      "title": "string",
      "gender": "string",
      "age": "string",
      "materials": [
        "string"
      ],
      "key_features": [
        "string"
      ],
      "offers": [
        {
          "merchant_id": "string",
          "price": {
            "currency": "string",
            "value": 0,
            "formatted_value": "string"
          },
          "availability": "string"
        }
      ],
      "variants": {
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "selected": {
          "name": "string",
          "value": "string"
        }
      },
      "structured_attributes": {
        "additionalProperties": [
          "string"
        ]
      },
      "brand": {
        "id": "string",
        "name": "string"
      },
      "images": [
        {
          "url": "string",
          "is_main_image": true,
          "is_cleaned_image": true,
          "shot_type": "string",
          "alt_text": "string"
        }
      ],
      "categories": [
        {
          "slug": "string",
          "title": "string",
          "path": [
            {
              "slug": "string",
              "title": "string"
            }
          ],
          "has_children": true
        }
      ]
    }
  ]
}
```

--------------------------------

### Search Products (CLI)

Source: https://docs.trychannel3.com/api-reference/v1/search

Perform a product search using the command-line interface. Ensure you provide your API key.

```CLI
channel3 products search \
  --api-key 'My API Key'
```

--------------------------------

### Retrieve Category Detail in Go

Source: https://docs.trychannel3.com/api-reference/v1/category-detail

Use the Go SDK to get category details. Initialize the client with your API key and provide the context and slug to the retrieve method.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	category, err := client.Categories.Get(context.TODO(), "slug")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", category.HasChildren)
}

```

--------------------------------

### Get Brand Detail

Source: https://docs.trychannel3.com/api-reference/v1/brand-detail

Fetches detailed information about a specific brand by its ID. This endpoint is useful for displaying brand-specific content or for integration into applications that require brand data.

```APIDOC
## GET /v1/brands/{brand_id}

### Description
Get detailed information about a specific brand by its ID.

### Method
GET

### Endpoint
/v1/brands/{brand_id}

### Parameters
#### Path Parameters
- **brand_id** (string) - Required - The unique identifier of the brand.

### Request Example
```
GET /v1/brands/brand_id
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the brand.
- **name** (string) - The name of the brand.
- **logo_url** (string | null) - The URL of the brand's logo.
- **description** (string | null) - A description of the brand.
- **best_commission_rate** (number) - The maximum commission rate for the brand, as a percentage. Defaults to 0.

#### Response Example
```json
{
  "id": "brand_id",
  "name": "Example Brand",
  "logo_url": "https://example.com/logo.png",
  "description": "This is an example brand description.",
  "best_commission_rate": 15.5
}
```

#### Error Responses
- **401** Unauthorized - Invalid or missing authentication.
- **402** Payment Required - You have used all of your free credits.
- **404** Not Found - Brand not found.
- **422** Validation Error - Indicates an issue with the request parameters.
- **500** Internal Server Error - An unexpected error occurred on the server.
```

--------------------------------

### Lookup Product with Go SDK

Source: https://docs.trychannel3.com/api-reference/v1/lookup-product

Integrate product lookup functionality using the Go SDK. Pass the API key and product URL to the lookup method.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	lookupResponse, err := client.Products.Lookup(context.TODO(), channel3go.ProductLookupParams{
		LookupRequest: channel3go.LookupRequestParam{
			URL: "url",
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", lookupResponse.Product)
}

```

--------------------------------

### Lookup Product with Python SDK

Source: https://docs.trychannel3.com/api-reference/v1/lookup-product

Utilize the Python SDK to fetch product information by its URL. The API key can be configured via environment variables.

```Python
import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
lookup_response = client.products.lookup(
    url="url",
)
print(lookup_response.product)
```

--------------------------------

### Use Channel3 Products Search Endpoint

Source: https://docs.trychannel3.com/sdk

Make a search request using the products.search endpoint of the Channel3 SDK. This example demonstrates basic usage for both TypeScript and Python.

```typescript
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
from channel3_sdk import Channel3

client = Channel3()

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

if __name__ == "__main__":
    main()
```

--------------------------------

### List Subscriptions via CLI

Source: https://docs.trychannel3.com/api-reference/price-tracking/list-subscriptions

Use the Channel3 CLI to list price tracking subscriptions. An API key must be provided.

```CLI
channel3 price-tracking list-subscriptions \
  --api-key 'My API Key'
```

--------------------------------

### List Subscriptions with Go SDK

Source: https://docs.trychannel3.com/api-reference/price-tracking/list-subscriptions

Fetch and print subscription details using the Go SDK. Requires context and API key configuration. Error handling is included.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.PriceTracking.ListSubscriptions(context.TODO(), channel3go.PriceTrackingListSubscriptionsParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

```

--------------------------------

### Lookup Product

Source: https://docs.trychannel3.com/api-reference/v1/lookup-product

Retrieve product information for any supported product URL. Returns the same Product model as GET /v1/products/{product_id}. The product_id in the response can be used with the Product Detail endpoint.

```APIDOC
## POST /v1/lookup

### Description
Retrieve product information for any supported product URL. Returns the same Product model as GET /v1/products/{product_id}. The product_id in the response can be used with the Product Detail endpoint.

### Method
POST

### Endpoint
/v1/lookup

### Request Body
- **url** (string) - Required - The URL of the product page.

### Request Example
```json
{
  "url": "url"
}
```

### Response
#### Success Response (200)
- **product** (object) - The detailed product information.

#### Response Example
```json
{
  "product": {
    "product_id": "string",
    "name": "string",
    "description": "string",
    "price": {
      "amount": "number",
      "currency": "string"
    },
    "image_url": "string",
    "url": "string"
  }
}
```

#### Error Responses
- **401** Unauthorized - Invalid or missing authentication
- **402** Payment required
- **404** Product not found
- **422** URL is not a product page or is on an unsupported domain
- **500** Unable to extract product data from the given URL
- **504** Timeout
```

--------------------------------

### Async Usage of Channel3 Products Search

Source: https://docs.trychannel3.com/sdk

Perform an asynchronous search request using the products.search endpoint with the Channel3 SDK. This example shows async operations in both TypeScript and Python.

```typescript
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
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())
```

--------------------------------

### Retrieve Website Information (Go)

Source: https://docs.trychannel3.com/api-reference/channel3-api/websites

This Go code snippet shows how to use the Channel3 SDK to retrieve website information. It requires setting the API key and specifying the query parameter for the website lookup.

```Go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	website, err := client.Websites.Get(context.TODO(), channel3go.WebsiteGetParams{
		Query: "query",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", website.ID)
}

```

--------------------------------

### Basic Channel3 CLI Command Structure

Source: https://docs.trychannel3.com/cli

Illustrates the general syntax for Channel3 CLI commands, showing the resource, command, and flags.

```sh
channel3 [resource] <command> [flags...]
```

--------------------------------

### List Categories using CLI

Source: https://docs.trychannel3.com/api-reference/v1/list-categories

Use the Channel3 CLI to list categories. Replace 'My API Key' with your actual API key.

```CLI
channel3 categories list \
  --api-key 'My API Key'
```

--------------------------------

### Get Product Detail

Source: https://docs.trychannel3.com/api-reference/v1/product-detail

Fetches detailed information for a specific product using its unique identifier. You can also specify optional parameters to filter the results by website, language, country, and currency.

```APIDOC
## GET /v1/products/{product_id}

### Description
Get detailed information about a specific product by its ID.

### Method
GET

### Endpoint
/v1/products/{product_id}

### Parameters
#### Path Parameters
- **product_id** (string) - Required - The unique identifier of the product.

#### Query Parameters
- **website_ids** (array[string] | null) - Optional - Optional list of website IDs to constrain the buy URL to, relevant if multiple merchants exist. Accepts website IDs or domains (e.g. "nike.com").
- **language** (string | null) - Optional - ISO 639-1 language code. Matches any language when unset; defaults to 'en' only when country and currency are also unset. Available options: en, de, fr, it, es, nl, sv, fi, pt, cs, el, ro.
- **country** (string | null) - Optional - ISO 3166-1 alpha-2 country code. Matches any country when unset; defaults to 'US' only when language and currency are also unset. Available options: US, GB, EU, AU, CA, IE, DE, AT, FR, BE, IT, ES, NL, SE, FI, PT, CZ, GR, RO.
- **currency** (string | null) - Optional - ISO 4217 currency code. When unset, inferred from `country` (e.g. GB -> GBP); falls back to 'USD' only when all three locale fields are unset. Available options: USD, CAD, AUD, GBP, EUR, SEK, CZK, RON.

### Response
#### Success Response (200)
- **Product** (object) - Detailed product information.

#### Error Response
- **401** - Unauthorized - Invalid or missing authentication. Example: {"detail": "Unauthorized. Missing authentication key. Make sure to attach an x-api-key with your request. Need help? Reach out to support@trychannel3.com."}
```

--------------------------------

### Retrieve Brand Detail in Go

Source: https://docs.trychannel3.com/api-reference/v1/brand-detail

This Go code snippet demonstrates how to use the Channel3 Go SDK to get brand details. Remember to replace 'My API Key' with your actual key.

```go
package main

import (
	"context"
	"fmt"

	"github.com/channel3-ai/sdk-go"
	"github.com/channel3-ai/sdk-go/option"
)

func main() {
	client := channel3go.NewClient(
		option.WithAPIKey("My API Key"),
	)
	brand, err := client.Brands.Get(context.TODO(), "brand_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", brand.ID)
}

```
Tokens:
Raw