{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper - Products, Prices & Shops in 9 Countries", "description": "Scrape Shopee products by keyword, category, shop or link in 9 countries (SG, MY, PH, TH, ID, VN, TW, BR, MX): title, price, discount, rating, ships-from, photos, with optional description, category path, brand and shop.", "version": "0.1", "x-build-id": "whVmKZXfYVbPPap04" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~shopee-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-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/automly~shopee-scraper/runs": { "post": { "operationId": "runs-sync-automly-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/automly~shopee-scraper/run-sync": { "post": { "operationId": "run-sync-automly-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": { "searchQueries": { "title": "Search words", "type": "array", "description": "What to search Shopee for, one search per line, e.g. phone case, sepatu wanita, tênis nike. Each search runs in the country chosen below.", "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "SG", "MY", "PH", "TH", "ID", "VN", "TW", "BR", "MX" ], "type": "string", "description": "Which Shopee site the search words run on, e.g. SG for shopee.sg. Prices come in that country's currency. Links below always use their own country.", "default": "SG" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "best_selling", "newest", "price_low_to_high", "price_high_to_low" ], "type": "string", "description": "Which order is read first, e.g. Top sales. Runs that ask for more than about 40 products also read the other orders to find more.", "default": "relevance" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lowest price in the country's currency, e.g. 10 (SGD) or 50000 (IDR)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Highest price in the country's currency, e.g. 100 (SGD) or 500000 (IDR)." }, "startUrls": { "title": "Shopee links", "type": "array", "description": "Paste Shopee links in any mix, e.g. a search page with your filters (shopee.sg/search?keyword=iphone&sortBy=sales), a category (shopee.co.id/Sepatu-Pria-cat.11042849), a shop (shopee.sg/apple.flagshipstore or shopee.sg/shop/442800909) or a product (shopee.com.br/...-i.123.456). Any of the 9 countries.", "items": { "type": "string" } }, "maxItems": { "title": "Max products per search or link", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "How many products to save for each search or link, e.g. 100. Set 0 for as many as Shopee shows (often 5,000+ for a broad search).", "default": 100 }, "includeDetails": { "title": "Include product page details", "type": "boolean", "description": "Open each product's page and add its full description, every photo and its category path; for some products also brand, rating count, stock, condition, variations and the shop's name and rating. Slower and charged as a detailed product. Not available on Shopee Taiwan.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Leave the default.", "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 } } } } } } } } } }