{ "openapi": "3.0.1", "info": { "title": "Shopee Scraper: 8 Countries, 900+ Products per Search", "description": "Over 900 products per keyword or category on 8 Shopee countries: price, discount, rating, badges. $3 per 1,000 products. Vietnam, Singapore, Philippines, Indonesia, Malaysia, Thailand, Taiwan, Brazil.", "version": "0.1", "x-build-id": "JmYgEpn3LUqbtDNga" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luzivanlt~shopee-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luzivanlt-shopee-products-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/luzivanlt~shopee-products-scraper/runs": { "post": { "operationId": "runs-sync-luzivanlt-shopee-products-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/luzivanlt~shopee-products-scraper/run-sync": { "post": { "operationId": "run-sync-luzivanlt-shopee-products-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": { "keywords": { "title": "Keywords", "type": "array", "description": "Words to search Shopee for, one search per keyword, e.g. \"tai nghe bluetooth\", on the site chosen under Country. Up to 200 characters each; the same keyword in another case is searched once. A link here is refused: paste it under Category or search links. Give at least one keyword or one link.", "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "vn", "sg", "ph", "id", "my", "th", "tw", "br" ], "type": "string", "description": "Which Shopee site to search the keywords on: vn, sg, ph, id, my, th, tw or br, e.g. id for shopee.co.id; Vietnam when left empty. A link is always read on its own site, whatever this says." }, "startUrls": { "title": "Category, search or product links", "type": "array", "description": "Links to Shopee category pages (shopee.vn/…-cat.11035567), searches (shopee.co.id/search?keyword=…) on any of the sites under Country, or products (shopee.vn/…-i.38518277.19881311830 or shopee.vn/product/38518277/19881311830) on any of them but shopee.tw and shopee.co.th, e.g. https://shopee.sg/Tops-cat.11012819.11027727. A category link covers its subcategories. A /list/… link is read as a keyword search. A product link gives one row: that product, with what its page shows (usually its price, description, brand, gallery, category path and shop). Shop and flash sale pages are refused.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "productIds": { "title": "Product ids", "type": "array", "description": "Products by their shop id and item id, as shop id/item id, e.g. 38518277/19881311830 (the two numbers at the end of a product link: …-i.38518277.19881311830). Read on the site chosen under Country (not tw or th); one row per product, as a product link gives.", "items": { "type": "string" } }, "maxProductsPerSearch": { "title": "Max products per keyword or link", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop each keyword or link after this many products, from 1 to 10,000; default 200 (the form starts at 50). Tested up to 1,000 per keyword or link; a narrow keyword gives fewer. Each product is charged once per run ($3 per 1,000 products), so this caps each search's cost. Example: 900 products cost at most $2.70.", "default": 200 }, "includeProductDetails": { "title": "Include product details", "type": "boolean", "description": "Also open each product's own page and add the seller's full description, the brand, every picture in the gallery, the product's category path, its number of ratings, and the shop's name and rating. Each product then takes one more page to read, so runs take longer (roughly 17 extra minutes per 1,000 products). Off by default." }, "includeShopDetails": { "title": "Include shop details", "type": "boolean", "description": "Also open each product's shop page and add the shop's follower count (as Shopee rounds it: 214,5k is 214500), and its name, rating, number of ratings, shop handle and logo. Each product then takes one more page to read, so runs take longer. Works with keywords, links and product ids. Off by default." } } }, "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 } } } } } } } } } }