API Documentation

Base URL: https://apicloak.io — All responses are JSON. All scraping endpoints are POST.

Authentication

All endpoints except /v1/health require an API key.

X-Api-Key: sk_live_your_key_here

Alternative: Authorization: Bearer sk_live_...

Proxy

All scraping endpoints require a proxy field. You provide your own residential or mobile proxy.

http://user:pass@host:port
socks5://user:pass@host:port

Tip: Datacenter proxies are usually blocked. Use residential or mobile for best results.

Shopee Endpoints

Regions (12)

Auto-detected from URL, or pass region explicitly. Default: tw.

Code	Domain	Country
`tw`	shopee.tw	Taiwan
`br`	shopee.com.br	Brazil
`sg`	shopee.sg	Singapore
`th`	shopee.co.th	Thailand
`id`	shopee.co.id	Indonesia
`my`	shopee.com.my	Malaysia
`ph`	shopee.ph	Philippines
`vn`	shopee.vn	Vietnam
`ar`	shopee.com.ar	Argentina
`mx`	shopee.com.mx	Mexico
`la`	shopee.com.la	Laos
`kh`	shopeekh.com	Cambodia

POST/v1/shopee/product

Full product details — name, description, pricing, rating, seller, images, categories, variant names.

Param	Type		Description
`url`	string	required	Shopee product URL
`proxy`	string	required	Your proxy URL

URL formats: Both shopee.tw/product-i.SHOP.ITEM and shopee.tw/product/SHOP/ITEM work.

curl -X POST https://apicloak.io/v1/shopee/product \
  -H "X-Api-Key: sk_live_..." -H "Content-Type: application/json" \
  -d '{"url":"https://shopee.tw/product/123/456","proxy":"http://user:pass@proxy:8080"}'

POST/v1/shopee/variants

Per-variant pricing, stock, tier variations, gallery, and promotions. Returns Shopee's full data.

Mode A: Pass url — IDs extracted automatically.
Mode B: Pass item_id + shop_id directly.

Param	Type		Description
`url`	string	mode A	Shopee product URL
`item_id`	string	mode B	Item ID
`shop_id`	string	mode B	Shop ID
`region`	string	optional	Region code (default: `tw`)
`proxy`	string	required	Your proxy URL

Price format: Divide single_value by 100,000 for display price. Example: 200000 = $2.00 TWD.

curl -X POST https://apicloak.io/v1/shopee/variants \
  -H "X-Api-Key: sk_live_..." -H "Content-Type: application/json" \
  -d '{"url":"https://shopee.tw/product/123/456","proxy":"http://user:pass@proxy:8080"}'

POST/v1/shopee/catalog

Browse a shop's entire product catalog. Returns up to 20 products per page with pricing, ratings, images, and variant info. Paginate with offset.

Param	Type		Description
`shop_id`	string	required	Shopee shop ID
`limit`	int	optional	Items per page, max 20 (default: 20)
`offset`	int	optional	Pagination offset (default: 0)
`region`	string	optional	Region code (default: `tw`)
`proxy`	string	required	Your proxy URL

curl -X POST https://apicloak.io/v1/shopee/catalog \
  -H "X-Api-Key: sk_live_..." -H "Content-Type: application/json" \
  -d '{"shop_id":"1097448496","region":"tw","proxy":"http://user:pass@proxy:8080"}'

Response

{
  "success": true,
  "data": {
    "items": [
      {
        "itemid": 29501839718,
        "shopid": 1097448496,
        "name": "Product Name",
        "price": 200000,
        "price_min": 200000,
        "price_max": 200000,
        "price_before_discount": 400000,
        "discount": "50%",
        "item_rating": {"rating_star": 4.9, "rating_count": [343,...]},
        "images": ["img1.jpg", "img2.jpg"],
        "tier_variations": [{"name": "Color", "options": [...]}],
        "bundle_deal_info": {"bundle_deal_label": "Buy 3 get 10% off"}
      }
    ],
    "total": 19,
    "limit": 20,
    "offset": 0
  },
  "request_id": "req_abc123",
  "latency_ms": 450
}

Note: Catalog returns item-level price ranges, not per-variant prices. Use /v1/shopee/variants for individual variant pricing.

POST/v1/shopee/shipping

Shipping channels, prices, estimated delivery, and free shipping rules for a product + destination.

Mode A: Pass url + zipcode.
Mode B: Pass item_id + shop_id + zipcode + region.

Param	Type		Description
`url`	string	mode A	Product URL
`item_id`	string	mode B	Item ID
`shop_id`	string	mode B	Shop ID
`zipcode`	string	required	Buyer's postal code
`city`	string	optional	City (improves accuracy)
`state`	string	optional	State code
`region`	string	optional	Region code (default: `tw`)
`proxy`	string	required	Your proxy URL

curl -X POST https://apicloak.io/v1/shopee/shipping \
  -H "X-Api-Key: sk_live_..." -H "Content-Type: application/json" \
  -d '{"item_id":"123","shop_id":"456","zipcode":"01310-100","region":"br","proxy":"http://user:pass@proxy:8080"}'

POST/v1/shopee/reviews

Product reviews with text, star ratings, images, variant info, and pagination.

Mode A: Pass url.
Mode B: Pass item_id + shop_id.

Param	Type		Description
`url`	string	mode A	Product URL
`item_id`	string	mode B	Item ID
`shop_id`	string	mode B	Shop ID
`limit`	int	optional	Per page, max 50 (default: 20)
`offset`	int	optional	Pagination offset
`type`	int	optional	Star filter: 0=all, 1-5=specific
`region`	string	optional	Region code (default: `tw`)
`proxy`	string	required	Your proxy URL

curl -X POST https://apicloak.io/v1/shopee/reviews \
  -H "X-Api-Key: sk_live_..." -H "Content-Type: application/json" \
  -d '{"url":"https://shopee.tw/product/123/456","limit":20,"proxy":"http://user:pass@proxy:8080"}'

POST/v1/shopee/shop

Shop profile, rating, follower count, response metrics, and product count.

Mode A: Pass url (any product URL from the shop).
Mode B: Pass shop_id.

Param	Type		Description
`url`	string	mode A	Any product URL from the shop
`shop_id`	string	mode B	Shop ID
`region`	string	optional	Region code (default: `tw`)
`proxy`	string	required	Your proxy URL

curl -X POST https://apicloak.io/v1/shopee/shop \
  -H "X-Api-Key: sk_live_..." -H "Content-Type: application/json" \
  -d '{"shop_id":"1097448496","region":"tw","proxy":"http://user:pass@proxy:8080"}'

POST/v1/shopee/flash-sales

Active flash sale items with discounted prices, original prices, flash stock, and promotion timing.

Param	Type		Description
`region`	string	optional	Region code (default: `tw`)
`category_id`	int	optional	Flash sale category filter (default: 0 = all)
`limit`	int	optional	Items per page, max 50 (default: 20)
`offset`	int	optional	Pagination offset
`proxy`	string	required	Your proxy URL

curl -X POST https://apicloak.io/v1/shopee/flash-sales \
  -H "X-Api-Key: sk_live_..." -H "Content-Type: application/json" \
  -d '{"region":"tw","proxy":"http://user:pass@proxy:8080"}'

Lazada Endpoints

Lazada endpoints return structured JSON with full product data. Proxy required.

Regions (6)

Code	Domain	Country
`sg`	lazada.sg	Singapore
`th`	lazada.co.th	Thailand
`vn`	lazada.vn	Vietnam
`my`	lazada.com.my	Malaysia
`ph`	lazada.com.ph	Philippines
`id`	lazada.co.id	Indonesia

POST/v1/lazada/product

Full product data — pricing, seller, specs, delivery, vouchers, warranties, reviews, and 25+ data fields per product.

Mode A: Pass url — item ID and region extracted automatically.
Mode B: Pass item_id + region directly.

Param	Type		Description
`url`	string	mode A	Lazada product URL
`item_id`	string	mode B	Lazada item ID
`region`	string	mode B	Region code (sg, th, vn, my, ph, id)
`proxy`	string	required	Your proxy URL

curl -X POST https://apicloak.io/v1/lazada/product \
  -H "X-Api-Key: sk_live_..." -H "Content-Type: application/json" \
  -d '{"item_id":"5928889081","region":"th","proxy":"http://user:pass@proxy:8080"}'

Response

{
  "api": "lazada.product.detail",
  "data": {
    "module": "{\"product\":{\"title\":\"...\",\"brand\":{...}},\"skuInfos\":{...},\"seller\":{...},\"review\":{...},\"specifications\":{...},\"deliveryOptions\":{...},\"vouchers\":{...},...}"
  },
  "ret": ["SUCCESS::..."],
  "traceId": "...",
  "v": "1.0"
}

The module field is a JSON string. Parse it to access product data: JSON.parse(response.data.module)

Module keys (25)

product, skuInfos, seller, review, specifications, productOption, skuGalleries, deliveryOptions, deliveryOptionsInfo, vouchers, warranties, warrantiesInfo, promotionTags, shopPromotion, Breadcrumb, primaryKey, globalConfig, disclaimers, recommendSkus, rules, tag, tracking, elevator, guideApp, seo

TikTok Shop Endpoints

TikTok Shop endpoints return structured JSON with full product data. Proxy required (regional proxy recommended).

Regions (11)

Code	Country
`us`	United States
`gb`	United Kingdom
`sg`	Singapore
`th`	Thailand
`vn`	Vietnam
`my`	Malaysia
`ph`	Philippines
`id`	Indonesia
`jp`	Japan
`mx`	Mexico
`kr`	South Korea

Products are region-locked. Use a proxy from the target region for best results.

POST/v1/tiktok/product

Full product data — pricing, SKU variants, reviews, seller info, shipping, promotions, and 30+ data fields per product.

Mode A: Pass url — product ID extracted automatically.
Mode B: Pass product_id + region directly.

Param	Type		Description
`url`	string	mode A	TikTok Shop product URL
`product_id`	string	mode B	19-digit product ID
`region`	string	optional	Region code (defaults to us)
`proxy`	string	required	Your proxy URL (regional proxy recommended)

curl -X POST https://apicloak.io/v1/tiktok/product \
  -H "X-Api-Key: sk_live_..." -H "Content-Type: application/json" \
  -d '{"product_id":"1729492204523128606","region":"sg","proxy":"http://user:pass@proxy:8080"}'

Response

{
  "success": true,
  "data": {
    "product_base": {"title": "...", "sold_count": 8798, "price": {...}, "images": [...], "specifications": [...]},
    "skus": [{...}, ...],
    "skuPriceInfo": [{...}, ...],
    "sale_props": [{...}, ...],
    "product_detail_review": {"product_rating": 4.8, "review_count": 1200, ...},
    "seller": {"name": "...", "seller_id": "...", "product_count": 55, ...},
    "logistic": {"delivery_option": [...], ...},
    "promotion_view": {...},
    ...
  },
  "request_id": "req_abc123",
  "latency_ms": 1200
}

Key data fields

product_base (title, description, images, sold_count, price), skus (all SKU variants), skuPriceInfo (per-SKU pricing), sale_props (variant options — color, size), product_detail_review (rating, reviews), seller (shop info), logistic (delivery options), pdp_logistic_module (shipping + return policies), promotion_view (active promotions), promotion_logos

Account

GET/v1/usage

Your usage stats, billing estimate, and rate limit status. Not rate-limited.

curl https://apicloak.io/v1/usage -H "X-Api-Key: sk_live_..."

GET/v1/health

Public health check. No auth required.

curl https://apicloak.io/v1/health

Reference

Error Codes

Code	Meaning	Cause
`400`	Bad Request	Missing fields, invalid JSON, no proxy
`401`	Unauthorized	Invalid API key
`402`	Payment Required	Insufficient credits
`403`	Forbidden	Key revoked or endpoint not in tier
`429`	Rate Limited	Too many requests
`502`	Upstream Error	Proxy failed or target unreachable

{"success": false, "error": "description", "request_id": "req_abc123"}

Rate Limits

Enforced per user, not per key. Rotating keys does not reset limits.

Header	Description
`X-RateLimit-Limit`	Max requests per minute
`X-RateLimit-Remaining`	Remaining this minute
`Retry-After`	Seconds to wait (on 429 only)
`X-Cache`	`HIT` or `MISS` — whether response was served from cache

Pricing

Shopee

Tier	Rate/min	Monthly Cap	Price per 1K
Starter	60	100K	$4.00
Growth	200	500K	$3.00
Scale	500	1M	$2.00
Enterprise	500	Unlimited	$1.50

Lazada

Tier	Rate/min	Monthly Cap	Price per 1K
Starter	60	100K	$2.50
Growth	200	500K	$2.00
Scale	500	1M	$1.20
Enterprise	500	Unlimited	$0.80

TikTok Shop

Tier	Rate/min	Monthly Cap	Price per 1K
Starter	60	100K	$2.50
Growth	200	500K	$1.80
Scale	500	1M	$1.00
Enterprise	500	Unlimited	$0.70

Products billed separately. Cached responses are still billed. Contact us for custom plans.