Platform availability
- 24h health
- Normal
Last 30 days
Available capabilities
Each Shopee action, what it does, its price and its health over the last 24 hours. Open an action for its parameters, response fields and code samples.
| Capability | What it does | Per 1,000 | 24-hour health |
|---|---|---|---|
Searchsearch | Search a Shopee marketplace for products by keyword, with price, original price and discount, rating, units sold, seller location and a Shopee Mall flag. | $1.39 per 1,000 requests | Normal |
Product detailsprofile | Open a Shopee product page by its full url for the description, price range across variants, stock, units sold, likes, brand and pre-order status. | $1.39 per 1,000 requests | Normal |
Shopshop | Browse the products a Shopee shop sells, by its username or numeric ID, with price, discount, rating, units sold and Mall status for each listing. | $1.39 per 1,000 requests | Normal |
Product detailsproduct_detail | Read a full Shopee listing from its product link, including description, variants, discount text, stock, units sold, reviews and the shop's name and location. | $1.39 per 1,000 requests | Temporarily unavailable |
Open a capability for its parameters, response fields, code samples and trial.
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.
| Action | Required | Optional | Delivery | Limit | Per 1,000 | Response fields |
|---|---|---|---|---|---|---|
searchSearch Search a Shopee marketplace for products by keyword, with price, original price and discount, rating, units sold, seller location and a Shopee Mall flag. | keyword | country, max_price, 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 Open a Shopee product page by its full | url | country | 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 · images · shop |
shopShop Browse the products a Shopee shop sells, by its username or numeric ID, with price, discount, rating, units sold and Mall status for each listing. Shop reviews, finances and private orders are not included, and the full catalog is not guaranteed. | shop | country | 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 Read a full Shopee listing from its product link, including description, variants, discount text, stock, units sold, reviews and the shop's name and location. Each market has its own currency, so read | 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 do the Shopee search parameters mean?
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.
keywordRequired- Specifies product search keywords for
search. The target regional marketplace is determined bycountry. 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 a recognized domain does not guarantee data for every region.product_detailusually reads the region from the product URL.Allowed values:brclcoidmxmyphsgthtwvn max_priceOptional- Sets the maximum item price using the target marketplace's price scale. Use it with min_price to define a range.
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?
Open a Shopee product page by its full url for the description, price range across variants, stock, units sold, likes, brand and pre-order status. Despite the name, this describes the item, not the buyer or seller; resolve shortened links to the landing page first.
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 IDs — Shopee 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 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 a recognized domain does not guarantee data for every region.product_detailusually reads the region from the product URL.Allowed values:brclcoidmxmyphsgthtwvn
What do the Shopee shop parameters mean?
Browse the products a Shopee shop sells, by its username or numeric ID, with price, discount, rating, units sold and Mall status for each listing. Shop reviews, finances and private orders are not included, and the full catalog is not guaranteed.
Full API reference: parameters, code samples, response example and health →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 Names — Shopee 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 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 a recognized domain does not guarantee data for every region.product_detailusually reads the region from the product URL.Allowed values:brclcoidmxmyphsgthtwvn
What do the Shopee product_detail parameters mean?
Read a full Shopee listing from its product link, including description, variants, discount text, stock, units sold, reviews and the shop's name and location. Each market has its own currency, so read price with currency; displayed stock does not confirm units available.
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 a recognized domain does not guarantee data for every region.product_detailusually reads the region from the product URL.Allowed values:bridmxmyphsgthvn
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 action runs asynchronously.
- 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 record, and every other action has its own field list.
Does every Shopee action return immediately?
Actions labeled asynchronous return a job ID you poll. Every other action can also run asynchronously: add "mode": "async" to the request body to receive a job ID immediately, useful for slow tasks or large limits. The current catalog contains sync delivery.