Shopee Search API
API health
- 24h health
- Normal
- 24h average time
- —
- Healthy / normal
- Available
- Limited
- Mostly down
Last 24 hours
Last 30 days
Search a Shopee marketplace for products by keyword, with price, original price and discount, rating, units sold, seller location and a Shopee Mall flag. country defaults to Indonesia, and price filters use that market's own currency.
Shopee Search finds products in one Shopee marketplace by keyword and returns each listing's name, link, image, price and original price with the discount percentage and currency, rating and rating count, units sold, location, whether it is a Shopee Mall store, and the shop and item IDs. Sellers, brands and market researchers working across Shopee's countries use it to map a category, compare prices across shops and track competitors.
country picks the marketplace and defaults to Indonesia, so set it for every other market, and remember that prices and price filters use that market's currency. is_mall marks official Shopee Mall stores, the first thing to check where counterfeits are a concern. location is passed through as Shopee shows it, and a null rating_count means Shopee keeps the number private; read it as unknown, not zero. sort orders by relevance, popular, newest or price in either direction.
Price $1.39 per 1,000 requests ($0.001389 per call). Failed calls and empty results are not charged. Synchronous. For slow jobs add "mode": "async" to the body, take the job_id and poll.
AI prompt
Paste this into your AI assistant. It already holds this endpoint's parameters, response fields and an example request, so the assistant can ask what you need and then write the scraper.
Please help me write a data collection script with the EveryInfra Shopee Search endpoint (shopee/search).
Endpoint contract:
- Request: POST https://api.everyinfra.com/api/v1/social with the header Authorization: Bearer <API key>. Read the key from the EVERYINFRA_API_KEY environment variable and never hard-code it.
- In the request body, set platform to shopee and action to search, and put the parameters inside params.
- Required parameters:
- keyword: Specifies product search keywords for search. The target regional marketplace is determined by country.
- Optional parameters:
- country: Sets the region code and takes precedence over region and URL inference. For search, profile, and shop, defaults to id (Indonesia) when unspecified. (allowed: br / cl / co / id / mx / my / ph / sg)
- max_price: Sets the maximum item price using the target marketplace's price scale. Use it with min_price to define a range.
- min_price: Sets the minimum item price for search based on the target market's currency scale. Do not assume values represent the same currency across regions. This parameter does not represent API billing amounts.
- sort: Sorts product search results for search. Allowed values are relevance, popular (sales-based), newest, price_asc, and price_desc. This parameter is not used for shop listings or product details. (allowed: newest / popular / price_asc / price_desc / relevance)
- limit: The most rows to return in this call, an integer from 1 to 100. The default applies when you leave it out, and a call can return fewer rows. Larger values return 422 before any charge. (default: 20)
- Returns a list of records. Main fields of each record: shop_id, item_id, name, url, image_url, price, original_price, discount_pct, currency, rating, rating_scale, rating_count; 15 fields in total, full list at https://api.everyinfra.com/api/v1/social/catalog?platform=shopee.
- Example request body:
{
"platform": "shopee",
"action": "search",
"params": {
"keyword": "wireless mouse"
}
}
- Price: $1.39 per 1,000 requests; failed and empty results are not charged.
- For dozens or hundreds of targets, add "mode": "async" to the body: you get a job_id at once and poll GET https://api.everyinfra.com/api/v1/jobs/{job_id} for the result.
- On 422, fix the request using the suggested parameter names and allowed values in the error; on 429 or 503, wait for Retry-After and try again.
Before writing code, ask me which targets I need, how many, which fields, and what output format I want; then confirm the plan and the rough cost with me.Request parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
Authorization | header | string | Yes | - | Bearer followed by your API key. Create it in the console; never put it in a URL or a code repository. |
platform | body | string | Yes | shopee | Platform identifier, fixed value. |
action | body | string | Yes | search | Capability identifier, fixed value. |
keyword | body.params | Not declared | Yes | - | Specifies product search keywords for search. The target regional marketplace is determined by country. |
country | body.params | enum | No | - | Sets the region code and takes precedence over region and URL inference. For search, profile, and shop, defaults to id (Indonesia) when unspecified. Configured domain detection includes sg, my, th, ph, vn, br, tw, mx, co, and cl, though a recognized domain does not guarantee data for every region. product_detail usually reads the region from the product URL.Allowed valuesbrclcoidmxmyphsgthtwvn |
max_price | body.params | Not declared | No | - | Sets the maximum item price using the target marketplace's price scale. Use it with min_price to define a range. |
min_price | body.params | Not declared | No | - | Sets the minimum item price for search based on the target market's currency scale. Do not assume values represent the same currency across regions. This parameter does not represent API billing amounts. |
sort | body.params | enum | No | - | Sorts product search results for search. Allowed values are relevance, popular (sales-based), newest, price_asc, and price_desc. This parameter is not used for shop listings or product details.Allowed valuesnewestpopularprice_ascprice_descrelevance |
limit | body.params | integer (1–100) | No | 20 | The most rows to return in this call, an integer from 1 to 100. The default applies when you leave it out, and a call can return fewer rows. Larger values return 422 before any charge. |
Code samples
curl -X POST 'https://api.everyinfra.com/api/v1/social' \
-H "Authorization: Bearer $EVERYINFRA_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"platform": "shopee",
"action": "search",
"params": {
"keyword": "wireless mouse"
}
}'[OpenAPI definition (JSON)]Samples read the key from the EVERYINFRA_API_KEY environment variable; copied code never contains your key.
Response example
Captured September 26, 2026 at 08:56 (UTC) by calling this API with the parameters in the code sample above. results and count are that call's real response with personal information (names, handles, avatars, profile links, contact details) removed; the list keeps the first 2. id, billing and quota differ on every call, so only their shape is shown.
{
"id": "req_…",
"platform": "shopee",
"action": "search",
"results": [
{
"shop_id": 487136590,
"item_id": 23911735997,
"name": "MOFii Mouse Wireless Gaming Rechargeable Baterai Type-C Fast Charging 1600DPI RGB Light P6",
"url": "https://shopee.co.id/MOFii-Mouse-Wireless-Gaming-Rechargeable-Baterai-Type-C-Fast-Charging-1600DPI-RGB-Light-P6-i.487136590.23911735997",
"image_url": "https://down-id.img.susercontent.com/file/id-11134207-7qul0-li9nrexr1rvb70",
"price": 80000,
"original_price": 299900,
"currency": "IDR",
"rating": 4.9,
"location": "Tangerang",
"is_mall": false,
"platform": "shopee",
"rating_scale": 5
},
{
"shop_id": 992148841,
"item_id": 25190075617,
"name": "[COD] Mouse Bluetooth Dual-Mode Wireless 2.4G Silent Mouse USB Portable Charging Gaming Mouse For IPad Windows los",
"url": "https://shopee.co.id/-COD-Mouse-Bluetooth-Dual-Mode-Wireless-2.4G-Silent-Mouse-USB-Portable-Charging-Gaming-Mouse-For-IPad-Windows-los-i.992148841.25190075617",
"image_url": "https://down-id.img.susercontent.com/file/id-11134207-7rbke-m8vjok4qdvcr7f",
"price": 30900,
"original_price": 58000,
"currency": "IDR",
"rating": 4.9,
"location": "Jakarta Barat",
"is_mall": false,
"platform": "shopee",
"rating_scale": 5
}
],
"count": 20,
"billing": {
"charged": …,
"charged_usd": …,
"balance_after_usd": …,
…
},
"quota": { … }
}Response fields
Business data is in results. The table lists the fields a record can contain; values the platform does not show are never made up.
| Field | Meaning |
|---|---|
shop_id | Keeps the platform's own meaning |
item_id | Keeps the platform's own meaning |
name | Name of the object itself, for account, product and business capabilities. |
url | Link to the record on the platform. |
image_url | Image link. Capabilities with several images may return an image_urls array. |
price | Price as a number without a currency symbol; see currency. |
original_price | Keeps the platform's own meaning |
discount_pct | Keeps the platform's own meaning |
currency | Currency code of the price (for example CNY, USD). If price is present but currency is null, do not assume a currency. |
rating | Rating. The scale varies by platform: rating_scale on the same row gives the maximum (usually 5; Booking, Douban, iQIYI and NAVER use 10). Convert with rating_scale before comparing across platforms, or the comparison can come out backwards. |
rating_scale | Maximum of rating in the same row: 5 for five-star scales, 10 for ten-point scales. Present only when the row has a rating. |
rating_count | Number of people who rated. null means not disclosed, not 0. |
sold_count | Keeps the platform's own meaning |
location | Location description passed through as is; the format varies by platform. |
is_mall | Keeps the platform's own meaning |
platform | Source platform identifier, the same as platform in the request (for example xiaohongshu, tiktok). |
FAQ
Which marketplace does a search cover?
One per call, set by country: id for Indonesia (the default), sg, my, th, ph, vn, tw, br, mx, co or cl. To compare a product across markets, run one search per country and keep currency with every row. A market with no matching listings returns no rows, and such a call is not charged.
How do I reach the full product page or the shop behind a result?
Each row carries item_id and shop_id. Pass the product's url to Shopee Product details for the full description, stock, variants and shop location. Pass shop_id, with the same country, to Shopee Shop to list the rest of that shop's products.
How do the price filters work across countries?
min_price and max_price use the currency of the market you search, the same one each row reports in currency. A price band that suits Singapore will not fit Indonesia or Vietnam, so set the filters per market. To see how deep a promotion goes, read discount_pct together with original_price and price.
Errors and billing
- 401
- Missing or invalid key. Authentication runs before parameter checks, so unauthenticated requests never see the parameter schema.
- 422
- Wrong parameter name or value. The error lists the parameters and allowed values this capability accepts and the closest match; it happens before any charge.
- 402
- Insufficient balance. Top up first.
- 429
- The account's per-minute request limit was reached (all of its API keys count together; a key's own lower limit applies first). Wait for Retry-After and try again; a rate package in the console raises the limit.
- 503
- Could not complete right now. Any charge for the call goes back to your balance automatically, and the billing receipt in the response states the actual outcome, including when it is not yet known. Do not resend blindly.
- 200 empty
- The request completed without data and is not charged (billing.reason = empty_result_refunded).