{
"openapi": "3.0.1",
"info": {
"title": "Shopee Scraper",
"description": "Extract Shopee product data from all 11 marketplaces without a browser: prices, discounts, ratings, units sold, shipping location, sellers and shops in Indonesia, Vietnam, Thailand, Brazil and more. Export data, run via API, schedule runs, or integrate with AI workflows.",
"version": "0.1",
"x-build-id": "l0JLjEx0tKu0Rc0jQ"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/lergassy~shopee-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-lergassy-shopee-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/lergassy~shopee-scraper/runs": {
"post": {
"operationId": "runs-sync-lergassy-shopee-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/lergassy~shopee-scraper/run-sync": {
"post": {
"operationId": "run-sync-lergassy-shopee-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": {
"mode": {
"title": "🧭 What to scrape",
"enum": [
"auto",
"search",
"product",
"shop"
],
"type": "string",
"description": "Choose the data type. Products from search – product cards from keyword search, category or listing URLs. Product details – full product pages with description, brand, gallery and seller. Shop – shop profile and its products. Auto decides by the URL you paste.",
"default": "auto"
},
"country": {
"title": "🌎 Country / marketplace",
"enum": [
"ID",
"SG",
"MY",
"PH",
"TH",
"VN",
"BR",
"TW",
"MX",
"CO",
"CL"
],
"type": "string",
"description": "Shopee marketplace for keyword searches. URLs keep their own country.",
"default": "ID"
},
"searchTerms": {
"title": "🔍 Search keywords",
"type": "array",
"description": "Products to search for, one per line, e.g. iphone 15. Each keyword is searched in the selected marketplace.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "🔗 Shopee URLs",
"type": "array",
"description": "Any Shopee links: product pages (.../Name-i.123.456), search results, category pages (...-cat.11044458) or shops (shopee.co.id/shopname).",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "💯 Max products",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Stop after this many products per keyword or URL.",
"default": 40
},
"enrichProducts": {
"title": "Fetch full product details for every result ($)",
"type": "boolean",
"description": "Open each product page for description, brand, image gallery, category path and seller reputation. Slower and billed per product detail.",
"default": false
},
"sortBy": {
"title": "Sort results",
"enum": [
"relevancy",
"sales",
"latest",
"price_asc",
"price_desc"
],
"type": "string",
"description": "Order of search results.",
"default": "relevancy"
},
"minPrice": {
"title": "Min price",
"minimum": 0,
"type": "integer",
"description": "Minimum price in the marketplace's own currency."
},
"maxPrice": {
"title": "Max price",
"minimum": 0,
"type": "integer",
"description": "Maximum price in the marketplace's own currency."
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Shopee serves pages per region. Residential proxies in the marketplace country give the most stable results.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Parallel requests.",
"default": 3
}
}
},
"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
}
}
}
}
}
}
}
}
}
}