Shopee Indonesia scraper API for AI agents and code
datawebot returns Shopee Indonesia search results and product pages as structured JSON, with the same fields for every shop: title, price, original price, availability, rating, image and link, plus details such as brand, variants and identifiers when a product page shows them. It runs from your AI agent over MCP or from code over REST on shopee.co.id in Indonesia, at 5 credits per search page and 1 per product page, and failed requests are free.
How Shopee Indonesia structures its product data: Shopee Indonesia data guide.
Fields you get
Every Shopee Indonesia product comes back in these fields; a field is null when the page doesn't show it. Each endpoint below also lists its raw record schema.
| Field | Type | Description |
|---|---|---|
product_id | string or null | Opaque id. Pass it to get_product (or capability "product") to read the product again. |
title | string | Product title as the shop shows it. |
url | string or null | The product page on the shop. |
shop | string or null | The shop’s hostname, without www. |
price | object or null | amount (number), currency (ISO 4217, or null when the shop doesn’t say) and text (the shop’s own wording when it is the same amount, else null). |
original_price | object or null | The price before a discount, in the same shape as price. |
rating | number or null | Average rating, on the shop’s own scale. |
review_count | integer or null | Number of reviews or ratings. |
image_url | string or null | Main product image. |
availability | string or null | in_stock, out_of_stock, or the shop’s own stock wording. |
sponsored | boolean or null | true for an ad the shop marks as sponsored; null when the page doesn’t say. |
How to run it
From your agent, after connecting it once with the setup prompt (agent setup), ask in plain words:
Use datawebot to extract https://shopee.co.id/search?keyword=iphone%2015 and give me each product's title, price and link as JSON.From code, send one request with your API key. The answer has the same shape for every shop; if it says "status": "working", read it again with GET /v1/requests/{id}.
curl https://api.datawebot.com/v1/requests \
-H "Authorization: Bearer $DATAWEBOT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"capability":"endpoint","endpoint":"shopee_id.search_items","url":"https://shopee.co.id/search?keyword=iphone%2015","max_pages":1,"format":"structured"}'Search
Shopee Indonesia keyword search (shopee.co.id/search?keyword=…): up to 60 products per page, page one by default and up to 25 pages. Product ID, shop ID, product URL, title, IDR card price and struck-through price, discount tag, rating and rating count, total and monthly sold, shop name, location and badge, brand, category, image, sold-out and sponsored flags, page and position, in Shopee's order (ads and repeats kept). No filters or sorting. A Job can take up to 85 minutes.
- ID
shopee_id.search_items- Version
1- Price
- 5 credits / page
- State
- Available
- Typical time
- About 180 s (estimate)
What it does
Reads one search results page (or up to the page limit) and returns one record per product card, in page order. Works on shopee.co.id; other hosts are rejected before anything runs.
Input
One page URL per request, shaped like https://shopee.co.id/search?keyword=iphone%2015, plus these bounded parameters.
| Parameter | Type | Allowed | Default | Set in /v1/requests |
|---|---|---|---|---|
max_pages | integer | 1–25 | 1 | max_pages |
Price
5 credits / page. With max_pages up to 25, a request costs at most 125 credits. Failed requests are free; a page that loaded but had nothing on it still costs credits. Set max_credits to refuse anything dearer before it runs.
Output
The default, "format": "structured". Every shop answers in the same fields, mapped from the page to the product_summary@1 schema. Fields are null when the page doesn't show them, and a record that can't be mapped is read best-effort from its raw fields. Products are in products, up to 50 a page; follow next_cursor with GET /v1/requests/{id} (MCP: get_results).
| Field | Type | Description |
|---|---|---|
product_id | string or null | Opaque id. Pass it to get_product (or capability "product") to read the product again. |
title | string | Product title as the shop shows it. |
url | string or null | The product page on the shop. |
shop | string or null | The shop’s hostname, without www. |
price | object or null | amount (number), currency (ISO 4217, or null when the shop doesn’t say) and text (the shop’s own wording when it is the same amount, else null). |
original_price | object or null | The price before a discount, in the same shape as price. |
rating | number or null | Average rating, on the shop’s own scale. |
review_count | integer or null | Number of reviews or ratings. |
image_url | string or null | Main product image. |
availability | string or null | in_stock, out_of_stock, or the shop’s own stock wording. |
sponsored | boolean or null | true for an ad the shop marks as sponsored; null when the page doesn’t say. |
{
"request_id": "string",
"status": "done",
"products": [
{
"product_id": "string or null",
"title": "string",
"url": "string or null",
"shop": "string or null",
"price": {
"amount": "number",
"currency": "string or null",
"text": "string or null"
},
"original_price": {
"amount": "number",
"currency": "string or null",
"text": "string or null"
},
"rating": "number or null",
"review_count": "integer or null",
"image_url": "string or null",
"availability": "string or null",
"sponsored": "boolean or null"
}
],
"next_cursor": "string or null",
"meta": {
"as_of": "date-time",
"country": "string",
"credits_used": "integer",
"credits_left": "integer"
}
}Over the Jobs API, GET /v1/jobs/{id}/results?format=structured returns the full product_summary@1 records.
With "format": "raw", the answer keeps the structured fields and adds raw: this endpoint's own records, unchanged, one per item, in the schema below. It is the data the endpoint extracted from the page, not the page's HTML. Same price as structured.
| Field | Type | Description |
|---|---|---|
product_id | string required | Shopee item ID (= item_id) |
shop_id | string required | Pattern ^[1-9][0-9]{0,15}$ |
item_id | string required | Pattern ^[1-9][0-9]{0,15}$ |
region | "id" | "my" | "sg" | "th" | "ph" | "vn" | "tw" | "br" required | — |
marketplace | "shopee.co.id" | "shopee.com.my" | "shopee.sg" | "shopee.co.th" | "shopee.ph" | "shopee.vn" | "shopee.tw" | "shopee.com.br" required | — |
url | string (uri) required | The product page, https://<host>/product/<shop id>/<item id>; a valid shopee_<region>.product_details input |
title | string required | — |
currency | string required | The region's currency (IDR on shopee.co.id): search items name no currency |
price | integer or null required | The card price as Shopee sends it (item_card_display_price.price), in units of 1/price_scale |
price_before_discount | integer or null required | The struck-through price (item_card_display_price.strikethrough_price), units of 1/price_scale; null without a discount |
price_scale | 100000 required | — |
discount_label | string or null required | The card's discount tag as shown, such as -4% |
rating | number or null required | item_rating.rating_star (0 with no ratings) |
review_count | integer or null required | item_rating.rating_count[0] |
sold | integer or null required | Total sold (historical_sold_count) |
monthly_sold | integer or null required | Sold in the last month (monthly_sold_count) |
shop_name | string or null required | — |
shop_location | string or null required | The shop's location as the card shows it, such as Kota Jakarta Barat |
seller_badge | string or null required | Shopee's seller flag on the card: OFFICIAL_SHOP, PREFERRED or PREFERRED_PLUS seen |
brand | string or null required | — |
category_id | string or null required | Shopee category ID (catid) |
image_id | string or null required | Pattern ^[A-Za-z0-9_-]{1,200}$ |
image_url | string (uri) or null required | https://down-<region>.img.susercontent.com/file/<image_id> |
sold_out | boolean or null required | — |
sponsored | boolean or null required | true for an ad (adsid or Shopee's is_ads tracking flag), false for an organic result, null when Shopee's markers disagree |
page | integer required | Minimum 1 |
position | integer required | 1-based rank across all pages, counting every item Shopee returned (ads and repeats included) |
stored_at | string (date-time) required | When the pgnt result gateway stored the search |
{
"product_id": "string",
"shop_id": "string",
"item_id": "string",
"region": "id | my | sg | th | ph | vn | tw | br",
"marketplace": "shopee.co.id | shopee.com.my | shopee.sg | shopee.co.th | shopee.ph | shopee.vn | shopee.tw | shopee.com.br",
"url": "string (uri)",
"title": "string",
"currency": "string",
"price": "integer or null",
"price_before_discount": "integer or null",
"price_scale": 100000,
"discount_label": "string or null",
"rating": "number or null",
"review_count": "integer or null",
"sold": "integer or null",
"monthly_sold": "integer or null",
"shop_name": "string or null",
"shop_location": "string or null",
"seller_badge": "string or null",
"brand": "string or null",
"category_id": "string or null",
"image_id": "string or null",
"image_url": "string (uri) or null",
"sold_out": "boolean or null",
"sponsored": "boolean or null",
"page": "integer",
"position": "integer",
"stored_at": "string (date-time)"
}Raw needs this endpoint: a search with format: "raw" doesn't fall back to shopping search, and answers raw_unavailable where no endpoint can run. Over the Jobs API, results are raw by default; format=both gives each raw record with its structured form.
Request
Run exactly this endpoint with capability: "endpoint"; there is no fallback, and a failed run is free. Set format to "raw" for the raw records too. For a keyword instead of a URL, search_products with this shop as site builds the search URL, tries the shop's endpoint first and then shopping search.
curl https://api.datawebot.com/v1/requests \
-H "Authorization: Bearer $DATAWEBOT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"capability":"endpoint","endpoint":"shopee_id.search_items","url":"https://shopee.co.id/search?keyword=iphone%2015","max_pages":1,"format":"structured"}'submit_job {
"endpoint": "shopee_id.search_items",
"url": "https://shopee.co.id/search?keyword=iphone%2015",
"max_pages": 1,
"format": "structured"
}If the answer says "status": "working", read it again with GET /v1/requests/{id} (MCP: get_results) after check_after_seconds.
Product details
Shopee Indonesia product page (shopee.co.id/product/<shop id>/<item id>): title, IDR price and the price range of the models in stock, price before discount and discount tag, availability, rating and review count, brand, categories, shop with its official-shop flag, images, description, and every variant with its options, price, price before discount and availability. Stock and total sold only when Shopee shows an exact number. No parameters. A Job can take up to 55 minutes.
- ID
shopee_id.product_details- Version
1- Price
- 1 credit / page
- State
- Available
- Typical time
- About 120 s (estimate)
What it does
Reads one product page and returns that product. Works on shopee.co.id; other hosts are rejected before anything runs.
Input
One page URL per request, shaped like https://shopee.co.id/product/255563049/23157471408.
Price
1 credit / page. Failed requests are free; a page that loaded but had nothing on it still costs credits. Set max_credits to refuse anything dearer before it runs.
Output
The default, "format": "structured". Every shop answers in the same fields, mapped from the page to the product@1 schema. Fields are null when the page doesn't show them, and a record that can't be mapped is read best-effort from its raw fields. The product is in product.
| Field | Type | Description |
|---|---|---|
product_id | string or null | Opaque id. Pass it to get_product (or capability "product") to read the product again. |
title | string | Product title as the shop shows it. |
url | string or null | The product page on the shop. |
shop | string or null | The shop’s hostname, without www. |
price | object or null | amount (number), currency (ISO 4217, or null when the shop doesn’t say) and text (the shop’s own wording when it is the same amount, else null). |
original_price | object or null | The price before a discount, in the same shape as price. |
rating | number or null | Average rating, on the shop’s own scale. |
review_count | integer or null | Number of reviews or ratings. |
image_url | string or null | Main product image. |
availability | string or null | in_stock, out_of_stock, or the shop’s own stock wording. |
sponsored | boolean or null | true for an ad the shop marks as sponsored; null when the page doesn’t say. |
product.details, when the shop's page maps to product@1:
| Field | Type | Description |
|---|---|---|
brand | string or null | Brand as the page names it. |
category_path | array of strings | Breadcrumb categories, top first. |
description | string or null | Plain-text description. |
feature_bullets | array of strings | Listed features. |
price_min, price_max | number or null | Lowest and highest variant price. |
discount_label | string or null | Discount wording, such as "-20%". |
stock | integer or null | Units in stock, when the page shows a number. |
sold_count, sold_count_basis | integer or null; "total", "monthly" or null | Units sold, and whether that is a total or per month. |
identifiers | array of {type, value} | asin, parent_asin, walmart_item_id, gtin, mpn, isbn or source_sku. |
specs_raw | array of {name, value} | The specification table as shown. |
images, image_count | array of {url, alt}; integer | Every product image. |
option_names | array of strings | Option names such as Size or Colour. |
variants, variant_count | array (100 per answer; next_cursor reads the rest); integer or null | Each variant: id, name, options, sku, final_price, price_before_discount, discount_label, available, stock, image_url. |
seller | object or null | id, name, url and type (official or marketplace). |
rating_scale | number or null | The top of the rating scale, such as 5. |
warnings | array of strings | Fields the page didn’t give, such as currency_missing. |
{
"request_id": "string",
"status": "done",
"product": {
"product_id": "string or null",
"title": "string",
"url": "string or null",
"shop": "string or null",
"price": {
"amount": "number",
"currency": "string or null",
"text": "string or null"
},
"original_price": {
"amount": "number",
"currency": "string or null",
"text": "string or null"
},
"rating": "number or null",
"review_count": "integer or null",
"image_url": "string or null",
"availability": "string or null",
"sponsored": "boolean or null",
"details": {
"brand": "string or null",
"variants": [
"…"
],
"…": "…"
}
},
"meta": {
"as_of": "date-time",
"country": "string",
"credits_used": "integer",
"credits_left": "integer"
}
}Over the Jobs API, GET /v1/jobs/{id}/results?format=structured returns the full product@1 records.
With "format": "raw", the answer keeps the structured fields and adds raw: this endpoint's own records, unchanged, one per item, in the schema below. It is the data the endpoint extracted from the page, not the page's HTML. Same price as structured.
| Field | Type | Description |
|---|---|---|
product_id | string required | Shopee item ID (the item_id in the URL) |
shop_id | string required | Pattern ^[1-9][0-9]{0,15}$ |
item_id | string required | Pattern ^[1-9][0-9]{0,15}$ |
region | "id" | "my" | "sg" | "th" | "ph" | "vn" | "tw" | "br" required | — |
marketplace | "shopee.co.id" | "shopee.com.my" | "shopee.sg" | "shopee.co.th" | "shopee.ph" | "shopee.vn" | "shopee.tw" | "shopee.com.br" required | — |
url | string (uri) required | Pattern ^https://shopee\.(co\.id|com\.my|sg|co\.th|ph|vn|tw|com\.br)/(product/[1-9][0-9]{0,15}/[1-9][0-9]{0,15}|[^/?#]+-i\.[1-9][0-9]{0,15}\.[1-9][0-9]{0,15})$ |
title | string required | — |
currency | string or null required | Pattern ^[A-Z]{3}$ |
price | integer or null required | As Shopee sends it, in units of 1/price_scale |
price_min | integer or null required | Minimum 0 |
price_max | integer or null required | Minimum 0 |
price_before_discount | integer or null required | Minimum 0 |
shown_price | integer or null required | The price the page shows (product_price.price), in units of 1/price_scale: its single value, after a voucher when Shopee shows one, or the low end of a shown range |
shown_price_max | integer or null required | The high end of a shown range (product_price.price.range_max); null when the page shows a single value |
shown_price_before_discount | integer or null required | The struck-through price the page shows (product_price.price_before_discount), single value or range low end |
price_scale | 100000 required | — |
discount_label | string or null required | — |
discount_hidden | boolean or null required | product_price.hide_discount: true when the page hides the discount text |
stock | integer or null required | Minimum 0 |
has_stock | boolean or null required | Shopee's own availability flags, not the stock count: true when any item.models entry has_stock, false when every one has none; without that, true for item.stock_display "IN STOCK". Null when unknown or contradictory. product@1 available prefers a known stock count |
sold | integer or null required | Minimum 0 |
rating | number or null required | Minimum 0 |
review_count | integer or null required | Minimum 0 |
brand | string or null required | — |
image_ids | array required | — |
description | string or null required | — |
categories | array required | — |
shop_name | string or null required | — |
official_shop | boolean or null required | — |
variant_count | integer or null required | Minimum 0 |
option_names | array required | — |
variants | array required | item.models of a product with variations (empty without them): options resolved from item.tier_variations, prices in units of 1/price_scale, image_id of the first tier option with an image |
source_endpoint | "get_pc" | "get_rw" required | get_rw only for shopee.com.br, whose pages may answer with it; same body shape as get_pc |
stored_at | string (date-time) required | When the product page data was stored |
{
"product_id": "string",
"shop_id": "string",
"item_id": "string",
"region": "id | my | sg | th | ph | vn | tw | br",
"marketplace": "shopee.co.id | shopee.com.my | shopee.sg | shopee.co.th | shopee.ph | shopee.vn | shopee.tw | shopee.com.br",
"url": "string (uri)",
"title": "string",
"currency": "string or null",
"price": "integer or null",
"price_min": "integer or null",
"price_max": "integer or null",
"price_before_discount": "integer or null",
"shown_price": "integer or null",
"shown_price_max": "integer or null",
"shown_price_before_discount": "integer or null",
"price_scale": 100000,
"discount_label": "string or null",
"discount_hidden": "boolean or null",
"stock": "integer or null",
"has_stock": "boolean or null",
"sold": "integer or null",
"rating": "number or null",
"review_count": "integer or null",
"brand": "string or null",
"image_ids": "array",
"description": "string or null",
"categories": "array",
"shop_name": "string or null",
"official_shop": "boolean or null",
"variant_count": "integer or null",
"option_names": "array",
"variants": "array",
"source_endpoint": "get_pc | get_rw",
"stored_at": "string (date-time)"
}Over the Jobs API, results are raw by default; format=both gives each raw record with its structured form.
Request
Read a product page with capability: "product"; it runs this endpoint for the page's shop. Set format to "raw" for the raw records too.
curl https://api.datawebot.com/v1/requests \
-H "Authorization: Bearer $DATAWEBOT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"capability":"product","url":"https://shopee.co.id/product/255563049/23157471408","format":"structured"}'get_product {
"url": "https://shopee.co.id/product/255563049/23157471408",
"format": "structured"
}If the answer says "status": "working", read it again with GET /v1/requests/{id} (MCP: get_results) after check_after_seconds.
Limits
- One page URL per request, on shopee.co.id only; other hosts are rejected before anything runs.
- A search or catalogue request reads at most 25 pages (
max_pages). - Prices and stock are read when the request runs (
meta.as_of); datawebot keeps no price history, so schedule and store repeat reads yourself. - Fields the page doesn't show come back null; nothing is filled in or guessed.
- Up to 30 requests a minute per account.
Questions about the Shopee Indonesia scraper API
Does Shopee Indonesia have an official API?
datawebot does not use one. It reads Shopee Indonesia's pages and returns them as structured JSON, so you need no Shopee Indonesia developer account or partner key. Whether Shopee Indonesia offers its own API, and on what terms, is for Shopee Indonesia to say.
Can I scrape Shopee Indonesia with Python?
Yes. Send the POST /v1/requests call shown on this page from Python with any HTTP client, such as requests or httpx: the same JSON body, with your API key in the Authorization header. The products come back in the answer's products field (product for a product page).
Is it legal to scrape Shopee Indonesia?
It depends on where you are, Shopee Indonesia's terms and what you do with the data. You stay responsible for how you use what datawebot returns. This is not legal advice; read our guide to robots.txt and legal considerations, and ask a lawyer about your case.
What does a Shopee Indonesia scraper API call cost?
5 credits per search page and 1 per product page. Failed requests are free; a page that loaded but had nothing on it still costs credits. Every account starts with 200 free credits, and credit packs start at 10,000 credits for $10, with no subscription.
Start with 200 free credits
Connect your agent with one setup prompt, or create an API key, and run Shopee Indonesia requests right away. No card and no subscription.
Connect your agent See pricing