{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper - All In One", "description": "All-in-one Shopee scraper to extract product, search, category, and shop data across multiple countries—fast, lightweight, and no browser or proxy required.", "version": "0.1", "x-build-id": "waRsc7X22bjhrceN6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-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/xtracto~shopee-scraper/runs": { "post": { "operationId": "runs-sync-xtracto-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/xtracto~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-xtracto-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", "required": [ "mode" ], "properties": { "country": { "title": "Country", "enum": [ "id", "sg", "my", "th", "ph", "vn", "br", "tw", "mx", "co", "cl" ], "type": "string", "description": "Shopee regional domain to scrape.", "default": "id" }, "mode": { "title": "Mode", "enum": [ "keyword", "url", "detail", "category", "shop" ], "type": "string", "description": "Scraping mode.", "default": "keyword" }, "keyword": { "title": "Keyword", "type": "string", "description": "Search keyword. Required for mode=keyword." }, "url": { "title": "Shopee URL", "type": "string", "description": "Any Shopee URL: product page, search result, category, or shop. Required for mode=url." }, "shopId": { "title": "Shop ID", "type": "integer", "description": "Seller shop ID. Required for mode=detail." }, "itemId": { "title": "Item ID", "type": "integer", "description": "Product item ID. Required for mode=detail." }, "category": { "title": "Category", "type": "string", "description": "Category slug or full URL. e.g. /Laptop-cat.11044364.11044440. Required for mode=category." }, "shop": { "title": "Shop", "type": "string", "description": "Shop username or numeric shop ID. Required for mode=shop." }, "sort": { "title": "Sort order", "enum": [ "relevancy", "sales", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Sort order for search/category results.", "default": "relevancy" }, "maxProducts": { "title": "Max products", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of products to return. Note: Shopee SEO render is capped at ~40 per sort variant.", "default": 40 }, "minPrice": { "title": "Min price filter", "type": "integer", "description": "Minimum price in local currency units (e.g. IDR, SGD). Only applies to keyword search." }, "maxPrice": { "title": "Max price filter", "type": "integer", "description": "Maximum price in local currency units. Only applies to keyword search." }, "delay": { "title": "Request delay (seconds)", "minimum": 0, "maximum": 10, "type": "number", "description": "Delay between HTTP requests to reduce rate-limit risk.", "default": 1 }, "fetchDetail": { "title": "Fetch full product detail", "type": "boolean", "description": "Jika true, setiap product card pada mode keyword/category/shop/url akan di-enrich dengan data lengkap (harga varian, stok, atribut, gambar, dll). Lebih lambat dan menggunakan lebih banyak request. Tidak berlaku untuk mode=detail (selalu lengkap).", "default": false } } }, "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 } } } } } } } } } }