EveryData platform API
Shopee API
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.
- 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 |
|---|---|---|---|---|---|---|
searchSearch Use Shopee | 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 |
profileProduct details Use Shopee | 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 |
shopShop Use | 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_detailProduct details Shopee keeps a single product record inside the | 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?
Use Shopee search with keyword for Shopee public results. Shopee search reads min_price, keyword, and sort, with name, image_url, shop_id, sold_count, is_mall, original_price, rating_count, platform, rating_scale, url, item_id, location, currency, rating, discount_pct, and price available in its response.
keywordRequired- Specifies product search keywords for
search. The target regional marketplace is determined bycountry. min_priceOptional- Sets the minimum item price for
searchbased 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 arerelevance,popular(sales-based),newest,price_asc, andprice_desc. This parameter is not used forshoplistings or product details.Allowed values:newestpopularprice_ascprice_descrelevance
What do the Shopee profile parameters mean?
Use Shopee profile to read one Shopee public record. For Shopee profile, url selects the Shopee record. Pass url to Shopee profile; returned objects expose item_id, brand, price_max, platform, discount_pct, is_pre_order, price, stock, rating_count, price_min, url, original_price, view_count, currency, name, description, shop_id, sold_count, rating, rating_scale, has_video, and liked_count.
urlRequired- Specifies the full Shopee product URL for
profileandproduct_detail.profileextracts identifiers using thei.shop_id.product_idpattern. 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
What do the Shopee shop parameters mean?
Use shop to retrieve one Shopee shop record, passing the shop identifier in shop. Public fields that Shopee hides or omits may be absent from the response. For Shopee shop, supply shop; results include shop_id, image_url, original_price, rating, name, currency, item_id, platform, discount_pct, rating_scale, sold_count, location, price, rating_count, is_mall, and url.
shopRequired- Specifies the shop username or numeric shop ID (with or without an
@prefix) forshop. 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
What do the Shopee product_detail parameters mean?
Shopee keeps a single product record inside the product_detail response scope. url identifies the target product record without changing the Shopee object used by product_detail. Call Shopee product_detail with country and url; Shopee product_detail exposes text, sold_count, price, original_price, shop_location, shop_name, discount, variants, currency, id, url, rating, platform, review_count, image_url, name, rating_scale, and stock.
urlRequired- Specifies the full Shopee product URL for
profileandproduct_detail.profileextracts identifiers using thei.shop_id.product_idpattern. 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
regionand URL inference. Forsearch,profile, andshop, defaults toid(Indonesia) when unspecified. Configured domain detection includessg,my,th,ph,vn,br,tw,mx,co, andcl, though domain support does not guarantee active data availability for every region.product_detailhandles 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.
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.