{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopee Product Scraper",
    "description": "Scrape Shopee products, prices, SKU variants, shops and reviews across Taiwan, Indonesia and Thailand. Keyword-search the marketplace, pull full product detail with stock and discounts, extract buyer reviews, and profile any seller. Clean JSON for price monitoring and market research.",
    "version": "1.0",
    "x-build-id": "oE36jLyltqOwEcH02"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~shopee-product-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-shopee-product-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/sian.agency~shopee-product-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-shopee-product-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/sian.agency~shopee-product-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-shopee-product-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "operation",
          "site"
        ],
        "properties": {
          "operation": {
            "title": "🎯 What do you want to scrape?",
            "enum": [
              "search",
              "productDetail",
              "productReviews",
              "shopProfile",
              "shopItems",
              "shopReviews"
            ],
            "type": "string",
            "description": "Pick one operation per run. Product Search finds products by keyword; Product Detail and Product Reviews take product URLs; the Shop operations take a shop URL or username.",
            "default": "search"
          },
          "site": {
            "title": "🌏 Marketplace",
            "enum": [
              "TW",
              "ID",
              "TH"
            ],
            "type": "string",
            "description": "Which Shopee marketplace to scrape. Taiwan, Indonesia and Thailand are supported. If you paste a full Shopee URL, the marketplace is detected from it automatically.",
            "default": "TW"
          },
          "keyword": {
            "title": "🔍 Search keyword",
            "type": "string",
            "description": "A single product search keyword. Used by Product Search.",
            "default": "iphone"
          },
          "keywords": {
            "title": "🔍 Search keywords (bulk)",
            "type": "array",
            "description": "Several keywords to search in one run - one row per product found.",
            "items": {
              "type": "string"
            }
          },
          "includeFacets": {
            "title": "🗂️ Include category facets",
            "type": "boolean",
            "description": "Also return the brand and category facets Shopee shows for the keyword. Adds one extra billed enrichment per keyword.",
            "default": false
          },
          "productUrl": {
            "title": "📦 Product URL",
            "type": "string",
            "description": "A Shopee product URL, e.g. https://shopee.tw/Some-Product-i.598490793.57509316914 . A bare 'shopId.itemId' pair also works. Used by Product Detail and Product Reviews."
          },
          "productUrls": {
            "title": "📦 Product URLs (bulk)",
            "type": "array",
            "description": "Several Shopee product URLs to process in one run.",
            "items": {
              "type": "string"
            }
          },
          "detailVersion": {
            "title": "🔀 Product data source",
            "enum": [
              "v1",
              "v2"
            ],
            "type": "string",
            "description": "Standard covers most products. Alternate is a separately-sourced feed - try it if Standard returns no data for a product. Alternate requires the full product URL.",
            "default": "v1"
          },
          "includeSkuMatrix": {
            "title": "🧬 Include SKU option matrix",
            "type": "boolean",
            "description": "Add the full variant matrix (every dimension and option combination). One extra billed enrichment per product.",
            "default": false
          },
          "includeSkuModels": {
            "title": "🧬 Include SKU model observations",
            "type": "boolean",
            "description": "Add observed per-model data for the product's variants. One extra billed enrichment per product.",
            "default": false
          },
          "includeSnapshot": {
            "title": "📸 Include display snapshot",
            "type": "boolean",
            "description": "Add the product's display snapshot as shown on the listing page. One extra billed enrichment per product.",
            "default": false
          },
          "includeInstallments": {
            "title": "💳 Include installment plans",
            "type": "boolean",
            "description": "Add installment and payment-plan information. Available for Taiwan and Indonesia only. One extra billed enrichment per product.",
            "default": false
          },
          "includeReviewModels": {
            "title": "📊 Include review distribution by variant",
            "type": "boolean",
            "description": "Add how reviews are distributed across the product's SKU models. One extra billed enrichment per product.",
            "default": false
          },
          "includeReviewTags": {
            "title": "🏷️ Include review tags",
            "type": "boolean",
            "description": "Add the review tag summary Shopee shows above the review list. One extra billed enrichment per product.",
            "default": false
          },
          "shopUrl": {
            "title": "🏬 Shop URL or username",
            "type": "string",
            "description": "A Shopee shop URL, e.g. https://shopee.tw/xiaomi.tw - or just the username. Used by the Shop operations."
          },
          "shopUrls": {
            "title": "🏬 Shop URLs (bulk)",
            "type": "array",
            "description": "Several Shopee shop URLs or usernames to process in one run.",
            "items": {
              "type": "string"
            }
          },
          "includeShopSeo": {
            "title": "📊 Include shop rating summary",
            "type": "boolean",
            "description": "Add the shop's public rating and listing summary. One extra billed enrichment per shop.",
            "default": false
          },
          "includeShopCategories": {
            "title": "🗂️ Include shop categories",
            "type": "boolean",
            "description": "Add the seller's own category structure. One extra billed enrichment per shop.",
            "default": false
          },
          "maxReviews": {
            "title": "🔢 Max reviews per target",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "How many reviews to collect per product or shop. Each review is one billed row.",
            "default": 50
          },
          "ratingFilter": {
            "title": "⭐ Star rating filter",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5"
            ],
            "type": "string",
            "description": "Only collect reviews with this star rating. All ratings returns everything.",
            "default": "0"
          },
          "reviewDetail": {
            "title": "🔀 Shop review depth",
            "enum": [
              "standard",
              "rich"
            ],
            "type": "string",
            "description": "Standard is the normal shop review feed. Enriched uses a fuller review source. Applies to Shop Reviews only.",
            "default": "standard"
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}