{
"openapi": "3.0.1",
"info": {
"title": "Shopee Product Scraper - Live Stock & Prices",
"description": "Scrape Shopee products by keyword or URL across all 8 markets. Get live stock, price, discount, units sold, rating, and shop data, plus optional full description, specifications, brand, category breadcrumb, and per-variant breakdown. No account or login needed. Export to JSON, CSV, or Excel.",
"version": "0.0",
"x-build-id": "CcS8xPg4mQTe2YyPp"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/zen-studio~shopee-product-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-zen-studio-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/zen-studio~shopee-product-scraper/runs": {
"post": {
"operationId": "runs-sync-zen-studio-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/zen-studio~shopee-product-scraper/run-sync": {
"post": {
"operationId": "run-sync-zen-studio-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",
"properties": {
"searchTerms": {
"title": "Search terms",
"type": "array",
"description": "Product keywords to search. All terms are searched together and de-duplicated toward one combined Max products total — add more terms to collect more.
Example: iphone 15, running shoes",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Shopee URLs",
"type": "array",
"description": "Paste Shopee search or shop page URLs. Sorting and filtering are controlled by the fields below, not by parameters inside a pasted URL. Single-product URLs are not supported here — use the Shopee Product Detail Scraper for those.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"shopId": {
"title": "Shop ID",
"type": "integer",
"description": "Scrape all products from one shop by its numeric shop ID."
},
"region": {
"title": "Region",
"enum": [
"SG",
"ID",
"MY",
"PH",
"TH",
"TW",
"VN",
"BR"
],
"type": "string",
"description": "Which Shopee market to scrape. Prices are returned in the market's local currency.",
"default": "SG"
},
"maxItems": {
"title": "Max products",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Maximum unique products to collect — total across all your search terms combined (de-duplicated), and per shop. A single search term returns up to a few hundred products, so add more terms for larger runs.",
"default": 100
},
"sort": {
"title": "Sort by",
"enum": [
"relevance",
"newest",
"price_low_to_high",
"price_high_to_low",
"best_selling"
],
"type": "string",
"description": "How to rank results within each context.",
"default": "relevance"
},
"includeEnrichment": {
"title": "Include description, specifications, brand & variant breakdown",
"type": "boolean",
"description": "Adds full product description, specifications, brand, category breadcrumb path, and a per-variant breakdown (price + stock per SKU). Products with enrichment are billed at an additional per-product rate.
Without this, base records still include price, stock, rating, vouchers, and all commercial fields from the listing.",
"default": false
},
"priceMin": {
"title": "Min price",
"type": "integer",
"description": "Keep only products priced at or above this value, in the region's local currency (e.g. SGD, IDR, BRL)."
},
"priceMax": {
"title": "Max price",
"type": "integer",
"description": "Keep only products priced at or below this value, in the region's local currency."
},
"minRating": {
"title": "Min rating",
"minimum": 1,
"maximum": 5,
"type": "integer",
"description": "Keep only products rated at or above this many stars (1–5)."
},
"minSold": {
"title": "Min units sold",
"minimum": 0,
"type": "integer",
"description": "Keep only products with at least this many total units sold."
},
"condition": {
"title": "Condition",
"enum": [
"any",
"new",
"used"
],
"type": "string",
"description": "Restrict to new or used items.",
"default": "any"
},
"discountedOnly": {
"title": "On sale only",
"type": "boolean",
"description": "Only products that currently have a discount.",
"default": false
},
"freeShippingOnly": {
"title": "Free shipping only",
"type": "boolean",
"description": "Only products eligible for free shipping.",
"default": false
},
"officialShopOnly": {
"title": "Official shops only",
"type": "boolean",
"description": "Only products from Shopee Mall official brand stores.",
"default": false
},
"preferredSellerOnly": {
"title": "Preferred sellers only",
"type": "boolean",
"description": "Only products from Preferred / Star sellers.",
"default": false
},
"codAvailableOnly": {
"title": "Cash on Delivery only",
"type": "boolean",
"description": "Only products that support Cash on Delivery.",
"default": false
},
"wholesaleOnly": {
"title": "Wholesale only",
"type": "boolean",
"description": "Only products offering wholesale (bulk) pricing.",
"default": false
},
"authenticOnly": {
"title": "100% authentic only",
"type": "boolean",
"description": "Only products flagged 100% original / authentic.",
"default": false
},
"withVideoOnly": {
"title": "With video only",
"type": "boolean",
"description": "Only products that include a product video.",
"default": false
},
"shippedFrom": {
"title": "Shipped from",
"type": "string",
"description": "Restrict to items shipped from a location (e.g. a city or state as shown in Shopee's \"Shipped From\" filter). Leave blank for all locations."
},
"brand": {
"title": "Brand",
"type": "string",
"description": "Restrict to a brand name (as shown in Shopee's brand filter for the category). Leave blank for all brands."
},
"language": {
"title": "Result language",
"type": "string",
"description": "Optional locale code for result text (e.g. en, zh-TW). Defaults to the region's primary language."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}