Query Shopee's unofficial API for product searches by keyword, category, or shop. Access detailed information including prices, orders, stock levels, and ratings. Also retrieve related entities like the category tree, shop listings, and keyword suggestions.
One or more URLs of the Shopee APIs to invoke. Look at the README document for detailed explanations and examples.
Proxy configuration
proxyobjectRequired
Select proxies to be used to scrape data. Use RESIDENTIAL proxies in the same country as your target.
Enrich URLs
enrichUrlQuerybooleanOptional
Automatically generate missing URL parameters. For example add result limits and session IDs.
Default value of this property is true
Generate referrers
generateReferrerbooleanOptional
Automatically generate the referrer HTTP header before sending API requests, to make them look more "authentic".
Default value of this property is true
Verbose logs
verboseLogsbooleanOptional
Enable this option to activate detailed logging within the scraper's operation. This feature is particularly useful for troubleshooting errors.
Default value of this property is true
Minimum concurrency
minConcurrencyintegerOptional
Minimum concurrency (parallelism) for the crawl.
Default value of this property is 1
Maximum concurrency
maxConcurrencyintegerOptional
Maximum concurrency (parallelism) for the crawl.
Default value of this property is 1
Maximum requests per crawl
maxRequestsPerCrawlintegerOptional
Maximum number of requests that the crawler will execute. The crawl will stop when this limit is reached.
Default value of this property is 999999999
Abort after too many consecutive blockages
maxConsecutiveBlockagesInTotalintegerOptional
Stop scraping when too many requests get blocked consecutively. This can happen with poor quality proxies or if this scraper is not compatible anymore with an upgraded anti-bot technology.
Default value of this property is 200
Security SDK Load Timeout
securitySdkLoadTimeoutMsintegerOptional
Sets the maximum time, in milliseconds, to wait for the Security SDK report from Shopee's anti-bot measures during website load.
Default value of this property is 20000
Max Page Reloads Per Proxy
maxPageReloadsPerProxyintegerOptional
Defines the limit for reloading a page using the same proxy when faced with blockages. Exceeding this limit triggers the use of a new proxy for the next attempt.
Default value of this property is 2
Website load failure screenshot
websiteLoadFailureScreenshotbooleanOptional
Enables capturing and saving a screenshot in the key-value store if the website fails to load, aiding in troubleshooting issues.
Minimum sales threshold to halt automatic page navigation in shop product listings. Crawling stops when a product with sales equal to or less than this value appears, assuming products are sorted by sales in descending order. Useful for scraping all selling products of a shop or a category and avoiding scraping products with no sales.
Crawl product details (product search)
productSearch_crawlProductDetailsbooleanOptional
Automatically crawl product details from the search results.
Default value of this property is false
Crawl product ratings (product detail)
productDetail_crawlProductRatingsarrayOptional
Automatically crawl product ratings after querying a product detail. Also indicate what filter to apply. If multiple filters are provided, requests for each filter are executed.
Maximum number of results to crawl when visiting product ratings.
Default value of this property is 3000
Automatically fix the error 10002 (product ratings)
productRatings_autofixError10002booleanOptional
Sometimes the product ratings API returns the error 10002. Enabling this option allows this scraper to fix this issue by splitting problematic requests into multiple smaller ones.
Default value of this property is true
Page size (shop search)
shopSearch_enrichUrlQuery_pageSizeintegerOptional
Maximum number of results per request to crawl when searching shops.
Default value of this property is 6
Crawl next pages (shop search)
shopSearch_crawlNextPagesbooleanOptional
Automatically crawl next pages when scraping search results.
Default value of this property is false
Maximum number of pages (shop search)
shopSearch_crawlNextPages_maxPagesintegerOptional
Maximum number of pages to crawl when searching shops.
Minimum sales threshold to halt automatic page navigation in shop product listings. Crawling stops when a product with sales equal to or less than this value appears, assuming products are sorted by sales in descending order. Useful for scraping all selling products of a shop and avoiding scraping products with no sales.
Crawl product details (shop products)
shopProducts_crawlProductDetailsbooleanOptional
Automatically crawl product details from the shop products listing.
