{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopee Search Scraper | Products, Prices & Categories",
    "description": "Get Shopee products by keyword, category or shop URL: title, price, original price, discount, rating, seller location, promo labels, image and URL. 9 markets (SG, MY, ID, TH, VN, PH, TW, BR, MX), all sort orders merged, price, rating and ship-from filters. No login.",
    "version": "0.0",
    "x-build-id": "H7mBKD4YQhygDc5th"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/genial_candlestand~shopee-product-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-genial_candlestand-shopee-product-search-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/genial_candlestand~shopee-product-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-genial_candlestand-shopee-product-search-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/genial_candlestand~shopee-product-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-genial_candlestand-shopee-product-search-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",
        "properties": {
          "queries": {
            "title": "Search keywords",
            "type": "array",
            "description": "No longer served: since November 2026 Shopee does not serve keyword search to anonymous visitors in any market, so keywords are rejected before the run starts and cost nothing. Use Start URLs (category or shop pages) or a Category ID instead; they work in all 9 markets.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Market",
            "enum": [
              "sg",
              "my",
              "id",
              "th",
              "vn",
              "ph",
              "tw",
              "br",
              "mx"
            ],
            "type": "string",
            "description": "Shopee market for the Category ID. Ignored for Start URLs: the URL's own site decides the market (shopee.co.id → ID). Shopee Colombia and Chile are closed and not offered.",
            "default": "sg"
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Shopee listing URLs from any of the 9 markets: a category URL (…/Mobile-Gadgets-cat.11013350), a category-scoped search URL without keyword (…/search?category=11013350) or a shop URL (…/shop/487895465; only the 3–12 products Shopee shows publicly). Keyword search URLs (…/search?keyword=…), product pages, shopee.com and other sites are rejected before the run starts.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "categoryId": {
            "title": "Category ID",
            "type": "string",
            "description": "Numeric Shopee category id of the chosen Market: the number after -cat. in a category URL (e.g. 11013350; for a subcategory the last number). Lists that category's page."
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "auto",
              "relevancy",
              "sales",
              "newest",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "Kept for compatibility: Shopee no longer serves keyword search, and category and shop pages come in Shopee's own order, so this setting has no effect.",
            "default": "auto"
          },
          "maxItemsPerQuery": {
            "title": "Max products per URL or category",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Stop each Start URL or category after this many unique products (1–1000). A category page shows 24 products and a shop page 3–12, so the run reports when a page is exhausted earlier.",
            "default": 100
          },
          "maxItems": {
            "title": "Max products in total",
            "minimum": 1,
            "type": "integer",
            "description": "Optional cap on all products of the run together. Empty = no total cap."
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "number",
            "description": "Only products from this price, in the market's currency units (e.g. 20 for R$20, 100000 for ₫100.000). Applied only to keyword searches, which Shopee no longer serves: no effect on category and shop pages."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "number",
            "description": "Only products up to this price, in the market's currency units. Must not be lower than Min price. Applied only to keyword searches, which Shopee no longer serves: no effect on category and shop pages."
          },
          "minRating": {
            "title": "Min rating",
            "minimum": 3,
            "maximum": 5,
            "type": "integer",
            "description": "Only products rated at least 3, 4 or 5 stars (5 = only 5.0). Applied only to keyword searches, which Shopee no longer serves: no effect on category and shop pages."
          },
          "location": {
            "title": "Shipped from",
            "type": "string",
            "description": "Only sellers shipping from this place, written exactly as in the market's Shopee Shipped From filter, e.g. São Paulo on shopee.com.br, Extranjero on shopee.com.mx. An unknown name returns no products. Applied only to keyword searches, which Shopee no longer serves: no effect on category and shop pages."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Used for category and shop pages: Apify datacenter proxy works for all markets (default); blocked requests are retried through residential proxy of the market's country.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}