EveryData platform API

Shopee API

Q: What can I retrieve with the Shopee API?

Set `platform` to `shopee`. The current catalog lists search, product details, shop, and product details. These action names identify different Shopee objects or views; they are not interchangeable search modes.

Q: Which input starts a Shopee `search` request?

Specifies product search keywords for `search`. The target regional marketplace is determined by `country`. Send it as `keyword` inside `params`.

Q: Which fields can Shopee `search` return?

Its declared schema includes `shop_id`, `item_id`, `name`, and `image_url`. A declared field can still be absent from an individual source record, and every other action has its own field list.

The Shopee catalog exposes 4 action-specific paths for Shopee product discovery, shops, shop details, and product details, beginning with `search`, `profile`, `shop` and preserving each object boundary.

The opening Shopee path, `search`, works with matching public results using `keyword`; `profile` instead works with the selected public record using `url`, preventing cross-action assumptions.

Start for free View the public catalog

Endpoint: POST /api/v1/social
Capabilities: 4
Per 1,000: $1.389

Available capabilities

Compare the Shopee actions by required input, returned data, and price. Use the action identifier exactly as shown in your request.

Action	Required	Optional	Delivery	Limit	Per 1,000	Response fields
`search` Search Search public results on Shopee. Accepts these parameters: `min_price`, `keyword`, and `sort`. Returns these fields: `name`, `image_url`, `shop_id`, and `sold_count`.	keyword	min_price, sort	Sync delivery	Catalog values: defaultLimit=20, maxLimit=100. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count.	$1.39 per 1,000 requests	shop_id · item_id · name · url · image_url · price · original_price · discount_pct · currency · rating · rating_scale · rating_count · sold_count · location · is_mall · platform
`profile` Product details Retrieve product details from Shopee. Accepts these parameters: `url`. Returns these fields: `item_id`, `brand`, `price_max`, and `discount_pct`.	url	—	Sync delivery	—	$1.39 per 1,000 requests	shop_id · item_id · name · url · description · price · price_min · price_max · original_price · discount_pct · currency · rating · rating_scale · rating_count · sold_count · stock · liked_count · view_count · brand · is_pre_order · has_video · platform
`shop` Shop Retrieve public shop details from Shopee. Accepts these parameters: `shop`. Returns these fields: `shop_id`, `image_url`, `original_price`, and `rating`.	shop	—	Sync delivery	Catalog values: defaultLimit=20, maxLimit=100. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count.	$1.39 per 1,000 requests	shop_id · item_id · name · url · image_url · price · original_price · discount_pct · currency · rating · rating_scale · rating_count · sold_count · location · is_mall · platform
`product_detail` Product details Retrieve product details from Shopee. Accepts these parameters: `country` and `url`. Returns these fields: `text`, `sold_count`, `price`, and `original_price`.	url	country	Sync delivery	—	$1.39 per 1,000 requests	id · url · name · text · price · original_price · currency · discount · stock · sold_count · rating · rating_scale · review_count · shop_name · shop_location · variants · image_url · platform

What does each Shopee action accept?

Each answer below pairs one callable action with its real inputs. Parameter meanings and allowed values are action-specific; a familiar name does not carry the same meaning across every platform.

Official sources are linked only to clarify the platform term beside them. They do not imply platform authorization or endorsement, and they do not add official-site features to the EveryInfra API contract.

What do the Shopee `search` parameters mean?

Search public results on Shopee. Accepts these parameters: min_price, keyword, and sort. Returns these fields: name, image_url, shop_id, and sold_count.

keywordRequired: Specifies product search keywords for search. The target regional marketplace is determined by country.
min_priceOptional: 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.
sortOptional: 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 values:newestpopularprice_ascprice_descrelevance

What do the Shopee `profile` parameters mean?

Retrieve product details from Shopee. Accepts these parameters: url. Returns these fields: item_id, brand, price_max, and discount_pct.

urlRequired: Specifies the full Shopee product URL for profile and product_detail. profile extracts identifiers using the i.shop_id.product_id pattern. Shortened links must be resolved to their landing page URL first and are not guaranteed to parse directly.
Shopee: Locating Shop and Item IDsShopee seller educational materials distinguish between Shop ID, Item ID, username, and shop display name, cautioning users against interchanging these identifiers. This reference cites these terms without guaranteeing identical back-office operating steps in other regions.Checked 2026-09-04

What do the Shopee `shop` parameters mean?

Retrieve public shop details from Shopee. Accepts these parameters: shop. Returns these fields: shop_id, image_url, original_price, and rating.

shopRequired: Specifies the shop username or numeric shop ID (with or without an @ prefix) for shop. Returns the shop's product listing rather than shop reviews.
Shopee: Differences Between Usernames and Shop Display NamesShopee documents login usernames separately from buyer-facing Shop Names. A shop display name may contain spaces and cannot directly replace the username or Shop ID required by this parameter.Checked 2026-09-04

What do the Shopee `product_detail` parameters mean?

Retrieve product details from Shopee. Accepts these parameters: country and url. Returns these fields: text, sold_count, price, and original_price.

urlRequired: Specifies the full Shopee product URL for profile and product_detail. profile extracts identifiers using the i.shop_id.product_id pattern. Shortened links must be resolved to their landing page URL first and are not guaranteed to parse directly.
countryOptional: 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 domain support does not guarantee active data availability for every region. product_detail handles region selection via an independent path.

How to use the Shopee API

01Read the public catalog and choose a platform action.
02Send the platform, action, and required parameters to POST /api/v1/social.
03Handle a synchronous result or poll the returned job ID when the selected action is asynchronous.
04Store the structured response fields needed by your application.

shopee_search.sh

curl -X POST https://api.everyinfra.com/api/v1/social \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"shopee","action":"search","params":{"keyword":"<keyword>"}}'

Shopee API questions

What can I retrieve with the Shopee API?

Set platform to shopee. The current catalog lists search, product details, shop, and product details. These action names identify different Shopee objects or views; they are not interchangeable search modes.

Which input starts a Shopee `search` request?

Specifies product search keywords for search. The target regional marketplace is determined by country. Send it as keyword inside params.

Which fields can Shopee `search` return?

Its declared schema includes shop_id, item_id, name, and image_url. A declared field can still be absent from an individual source record, and every other action has its own field list.

Does every Shopee action return immediately?

No assumption is needed: this page labels each action's delivery mode. The current catalog contains sync delivery; poll a returned job ID only for an action labeled asynchronous.

1688 API AliExpress API Amazon API Craigslist API eBay API Etsy API Taobao API Temu API View the public catalog →