{ "openapi": "3.0.1", "info": { "title": "Shopee Search Results Scraper", "description": "Collect products from Shopee search results by keyword or search URL. Each row includes the title, current and original prices, discount, rating, seller location, image, product URL, and shop and item IDs. Supports eight markets and reads public pages without login.", "version": "0.1", "x-build-id": "h5Tgmg8eIionhedMd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~shopee-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-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/axiomworks~shopee-product-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-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/axiomworks~shopee-product-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-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 keywords", "type": "array", "description": "Keywords to search on Shopee, one per line, in any language, e.g. 'wireless earbuds', 'sepatu', '鞋子'. Each keyword is searched on the Country market and returns one row per product card (title, price, discount, rating, location). Give searchTerms, startUrls or both. A keyword with no matching products returns 0 rows and a warning.", "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "SG", "MY", "PH", "ID", "TH", "VN", "TW", "BR" ], "type": "string", "description": "Shopee market the keywords are searched on, default SG. SG shopee.sg (SGD), MY shopee.com.my (MYR), PH shopee.ph (PHP), ID shopee.co.id (IDR), TH shopee.co.th (THB), VN shopee.vn (VND), TW shopee.tw (TWD), BR shopee.com.br (BRL). Applies to searchTerms only; startUrls use the market in their URL.", "default": "SG" }, "startUrls": { "title": "Shopee search URLs", "type": "array", "description": "Shopee search result URLs from any of the 8 markets, as strings or {\"url\": ...} objects, e.g. https://shopee.com.br/search?keyword=t%C3%AAnis&sortBy=sales. sortBy and order in the URL are kept. Category, shop and product URLs are not supported: they are skipped with a warning. Optional when searchTerms is given." }, "sortBy": { "title": "Sort by", "enum": [ "relevancy", "sales", "ctime", "price_asc", "price_desc" ], "type": "string", "description": "Result order for searchTerms, default relevancy (Shopee's own ranking). sales = top sales, ctime = newest, price_asc / price_desc = by price. Start URLs keep their own sortBy/order.", "default": "relevancy" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only products priced at or above this amount, in the market's currency (SG dollars for SG, rupiah for ID, etc.). Applied by Shopee to searchTerms; leave empty for no limit. Start URLs keep their own minPrice." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only products priced at or below this amount, in the market's currency. Applied by Shopee to searchTerms; leave empty for no limit. Start URLs keep their own maxPrice." }, "minRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only products rated this many stars or more (1-5). Applied by Shopee to searchTerms; leave empty for any rating. Start URLs keep their own ratingFilter." }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of products to return in total, shared across all keywords and URLs (split evenly, leftovers go to the next target), 1-10000, default 50. Shopee shows 40 products per page and up to 16 pages per search. The run stops as soon as this many results are saved, and you are charged only for results returned.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy to use for requests, default Apify Proxy (datacenter). Switch to residential proxies only if runs get blocked.", "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 } } } } } } } } } }