# Shopee Search

## Overview

| Property | Value |
|----------|-------|
| **Status** | private |
| **Method** | `GET` |
| **Endpoint** | `/v2/shopee/search` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/shopee-search |

## Description

Extract detailed Shopee product information using our API for market insights and data-driven decisions.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/shopee/search' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Example

```json
{
  "data": {
    "query": "tas wanita",
    "results": [
      {
        "name": "Tas Wanita Model A",
        "sold": 300,
        "price": "150000",
        "rating": 4.5,
        "reviews": 120,
        "currency": "IDR",
        "image_url": "https://cf.shopee.co.id/file/123456abcdef.jpg",
        "product_id": "123456",
        "product_url": "https://shopee.co.id/product/123456"
      },
      {
        "name": "Tas Wanita Model B",
        "sold": 250,
        "price": "200000",
        "rating": 4.7,
        "reviews": 98,
        "currency": "IDR",
        "image_url": "https://cf.shopee.co.id/file/abcdef123456.jpg",
        "product_id": "123457",
        "product_url": "https://shopee.co.id/product/123457"
      },
      {
        "name": "Tas Wanita Model C",
        "sold": 220,
        "price": "175000",
        "rating": 4.6,
        "reviews": 85,
        "currency": "IDR",
        "image_url": "https://cf.shopee.co.id/file/7890abc123.jpg",
        "product_id": "123458",
        "product_url": "https://shopee.co.id/product/123458"
      }
    ],
    "pagination": {
      "page": 1,
      "total_pages": 20,
      "next_page_url": "https://shopee.co.id/search?keyword=tas%20wanita&page=2",
      "total_results": 200
    }
  },
  "status": "success"
}
```

## Documentation

## Overview
Extract detailed Shopee product information using our API for market insights and data-driven decisions.

## Quickstart
```
GET https://api.piloterr.com/v2/shopee/search?query=example
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Search query or target identifier |

## Main use cases
- Integrate Shopee Search data into enrichment, analytics, and monitoring pipelines
- Automate large-scale extraction from Shopee without maintaining scrapers
- Power internal dashboards and workflow automations with live Shopee data