Shopee Product Search

Search and filter products across supported Shopee markets in Asia and Latin America for product selection and marketplace. Available via REST API or MCP.

CostRecent 10 credits / call

Try online

POST · https://api.nexscope.ai/yy/shopee/getProductInfosMCP · nexscope_shopee_product_search

Choose an integration method

Shopee Product Research

What this API does

Search and filter products across supported Shopee markets in Asia and Latin America for product selection and marketplace. The request accepts station, keyword, keywordType, notExistKeyword, notExistKeywordType. Its documented result includes totalSize, sourceType, products, pid, title, description, imageUrl, productUrl.

Shopee Product Search API use cases

Investigate a seller or store

To investigate a seller or store, a marketplace analyst submits station and keyword to Shopee Product Search. The returned totalSize, sourceType, products help identify the store associated with a candidate product.

Compare storefront product evidence

A marketplace analyst uses Shopee Product Search with station and keyword to compare storefront product evidence. The returned totalSize, sourceType, products help compare products or listings across shortlisted storefronts.

Shortlist stores for further research

For this workflow, a marketplace analyst calls Shopee Product Search with station and keyword to shortlist stores for further research. The result helps choose stores for a supplier or competitor review.

Shopee Product Search API FAQ

What does the Shopee Product Search API return?

Search and filter products across supported Shopee markets in Asia and Latin America for product selection and marketplace. The documented output includes totalSize, sourceType, products, pid, title, description, imageUrl, productUrl. It corresponds to the supplied station, keyword, keywordType, notExistKeyword, notExistKeywordType. Optional fields can be absent; a missing value should not be interpreted as a measured zero. Example values illustrate the response shape, rather than live account results.

How many credits does the Shopee Product Search API cost?

The current documented cost is Recent 10 credits / call. This is the same cost shown at the top of this page. If a range or estimate is displayed, the final charge depends on the request. Review your available credits and the pricing page before calling the API, and check API usage records for the actual charge.

How do I call the Shopee Product Search API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/yy/shopee/getProductInfos with your API key as a Bearer token and the JSON inputs shown in API integration. In a compatible MCP client such as Claude or Cursor, connect Nexscope and call nexscope_shopee_product_search. Use the MCP arguments shown in the MCP guide, or switch Online test to MCP to review its request before adding it to your app.

View plans and credits Connect this API with MCP

Try this API

Endpoint

https://api.nexscope.ai/yy/shopee/getProductInfos

MCP method

nexscope_shopee_product_search

Step 1 of 3 · Authenticate

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk-xxxxxxxxxxxxxxxxx

Missing or invalid API keys return an authentication error. Manage keys from .

Step 2 of 3 · Send a request

POSThttps://api.nexscope.ai/yy/shopee/getProductInfos

Run an API

Send a JSON request body using the parameters described below.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/yy/shopee/getProductInfos' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "Storage Box",
  "keywordType": 2,
  "orderBy": "sold",
  "orderByType": "DESC",
  "pageSize": 50,
  "soldMin": 100,
  "station": "malaysia"
}'

Step 3 of 3 · Inspect the result

Check the response

Read code for the request status and data for the result. Open the parameter and response reference for the full field definitions.

HTTP status codes

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

View parameters & response Try online

All categories/ Shopee Product Research

POSThttps://api.nexscope.ai/yy/shopee/getProductInfos

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Open tester

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/yy/shopee/getProductInfos`
Auth	`Bearer API key`
Content-Type	`application/json`

Request parameters

Name	Type	Required	Description
`station`	`string`	optional	Required. Shopee site, you can pass the name or code. See site mapping table below.
`keyword`	`string`	optional	Product title keywords.
`keywordType`	`integer`	optional	Matching mode: 1=whole sentence (default), 2=multi-word AND, 3=multi-word OR.
`notExistKeyword`	`string`	optional	Exclude products containing this keyword.
`notExistKeywordType`	`integer`	optional	Exclude match patterns: 1=whole sentence (default), 2=multi-word AND, 3=multi-word OR.
`priceMin`	`number`	optional	Total product price starting value (local currency).
`priceMax`	`number`	optional	The end value of the total price of the product.
`soldMin`	`integer`	optional	The starting value of the number of units sold in the previous 30 days.
`soldMax`	`integer`	optional	The end value of the number of units sold in the previous 30 days.
`estimateSoldStart`	`integer`	optional	Estimate the starting value of the number of units sold in the first 30 days.
`estimateSoldEnd`	`integer`	optional	Estimate the end value of the number of units sold in the first 30 days.
`historicalSoldStart`	`integer`	optional	The starting value of the total number of units sold of the product.
`historicalSoldEnd`	`integer`	optional	The end value of the total number of units sold of the product.
`paymentStart`	`number`	optional	The starting value of sales amount in the previous 30 days.
`paymentEnd`	`number`	optional	Ending value of sales amount in the previous 30 days.
`ratingMin`	`number`	optional	Minimum product rating (0-5).
`ratingMax`	`number`	optional	Maximum product rating.
`ratingsMin`	`integer`	optional	The starting value of the score.
`ratingsMax`	`integer`	optional	The end value of the score.
`favoriteMin`	`integer`	optional	The starting value of the number of collections.
`favoriteMax`	`integer`	optional	End value of collection count.
`skuNumberStart`	`integer`	optional	Starting value of the total number of SKUs.
`skuNumberEnd`	`integer`	optional	The end value of the total number of SKUs.
`listingDateFrom`	`string`	optional	The starting value of product shelf time (format: yyyy-MM-dd).
`listingDateTo`	`string`	optional	Product shelf end value (format: yyyy-MM-dd).
`statTimeStart`	`string`	optional	Starting value of statistical time (format: yyyy-MM-dd HH:mm:ss).
`statTimeEnd`	`string`	optional	End value of statistical time (format: yyyy-MM-dd HH:mm:ss).
`lastModiTimeStart`	`string`	optional	The latest crawl time starting value (format: yyyy-MM-dd).
`lastModiTimeEnd`	`string`	optional	The latest crawl time end value (format: yyyy-MM-dd).
`approvedDateStart`	`string`	optional	The starting value of the store opening time (format: yyyy-MM-dd).
`approvedDateEnd`	`string`	optional	The end value of the store opening time (format: yyyy-MM-dd).
`pL1Id`	`string`	optional	Level 1 category ID.
`pL2Id`	`string`	optional	Level 2 category ID.
`pL3Id`	`string`	optional	Level 3 category ID.
`cidList`	`string`	optional	Category id list, complete path, multiple groups separated by `｜`, such as: `AAA,BBB,CCC｜DDD,EEE`.
`shopIdList`	`string`	optional	Specify a list of store IDs, separated by multiple commas.
`notExistShopIdList`	`string`	optional	Exclude a list of store IDs, separated by multiple commas.
`merchant`	`string`	optional	Store name or user name.
`shopLocation`	`string`	optional	Store location.
`shippingIconType`	`integer`	optional	Store location: 0=local, 1=overseas.
`cbOption`	`integer`	optional	Shipping location: 0=domestic, 1=cross-border.
`isShopeeVerified`	`integer`	optional	Shopee Preferred: 0=not preferred, 1=preferred.
`isOfficialShop`	`integer`	optional	Official store: 0=no, 1=yes.
`isHotSales`	`integer`	optional	Whether it is a hot seller: 0 = not a hot seller, 1 = a hot seller.
`pids`	`string`	optional	List of product IDs (up to 500), separated by commas.
`orderBy`	`string`	optional	Sorting fields: `rating` (rating), `price` (price), `historical_sold` (total sales), `sold` (30-day sales), `payment` (30-day sales), `favorite` (number of collections), `ratings` (number of ratings), `gen_time` (time on shelves), `estimate_sold` (estimated sales).
`orderByType`	`string`	optional	Sorting direction: `ASC` (ascending order), `DESC` (descending order). Example: DESC
`page`	`integer`	optional	Page number (starting from 1). Example: 1
`pageSize`	`integer`	optional	Number of items per page (range 1-1000). Example: 1000

Code example

{
  "keyword": "Storage Box",
  "keywordType": 2,
  "orderBy": "sold",
  "orderByType": "DESC",
  "pageSize": 50,
  "soldMin": 100,
  "station": "malaysia"
}

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "code": 0,
  "cost": "-1",
  "data": {},
  "msg": null,
  "time": "2026-01-01 00:00:00",
  "traceId": null,
  "ts": "0"
}

Response fields

Response field reference (46 fields)

Name	Type	Required	Description
`total`	`integer`	optional	The current number of records returned.
`totalSize`	`integer`	optional	Total number of results.
`sourceType`	`string`	optional	Source type: `shopee`.
`columns`	`array`	optional	Render column definitions.
`costToken`	`integer`	optional	Consume token.
`type`	`string`	optional	Rendering style.
`products`	`array`	optional	List of products (see fields below).
`pid`	`string`	optional	Product unique ID.
`title`	`string`	optional	Product title.
`description`	`string`	optional	Product description.
`imageUrl`	`string`	optional	Product main image URL.
`productUrl`	`string`	optional	Shopee product link.
`shopeeUrl`	`string`	optional	Product links under the Shopee domain name.
`price`	`number`	optional	Product default price (local currency).
`minPrice`	`number`	optional	SKU lowest price.
`maxPrice`	`number`	optional	The highest price of the SKU.
`sold`	`integer`	optional	Number of units sold in the previous 30 days.
`estimateSold`	`integer`	optional	Estimate the number of units sold in the previous 30 days.
`historicalSold`	`integer`	optional	The total number of items sold.
`payment`	`number`	optional	Sales in the previous 30 days (local currency).
`rating`	`number`	optional	Product rating (0-5).
`ratings`	`integer`	optional	Rating number.
`favorite`	`integer`	optional	Number of collections.
`viewCount`	`integer`	optional	Number of views.
`stock`	`integer`	optional	Stock count.
`skuNumber`	`integer`	optional	SKU quantity.
`genTime`	`string`	optional	Shelf time.
`statTime`	`string`	optional	Statistics time.
`lastModiTime`	`string`	optional	Latest crawl time.
`categoryStructure`	`string`	optional	Category structure path.
`cid`	`string`	optional	Category IDs (comma separated).
`shopId`	`string`	optional	Store ID.
`shopName`	`string`	optional	Store name.
`shopUrl`	`string`	optional	Store link.
`userName`	`string`	optional	Store owner name.
`shopLocation`	`string`	optional	Store location.
`shopProductsCount`	`integer`	optional	The total number of items in the store.
`approvedDate`	`string`	optional	Store opening hours.
`isOfficialShop`	`integer`	optional	Is it an official store (1=yes, 0=no).
`isShopeeVerified`	`integer`	optional	Shopee is preferred (1=yes, 0=no).
`isHotSales`	`integer`	optional	Is it a hot seller (1=yes, 0=no).
`shippingIconType`	`integer`	optional	Store location type (0=local, 1=overseas, 3 or null=unknown).
`cbOption`	`integer`	optional	Shipping location (0=domestic, 1=cross-border).
`estimatedDays`	`integer`	optional	Estimated days of arrival.
`status`	`integer`	optional	Product status (1=normal, 0=removed, 8=excluded from list).
`notExist`	`integer`	optional	Whether it exists (0=exists, 1=does not exist).

Responses

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

Data source, freshness, and limitations

Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.

Step 1 of 2 · Connect your MCP client

MCP

V2 recommended

Connect remote agents through the standard MCP 2025-11-25 Streamable HTTP endpoint. Use OAuth 2.1 Authorization Code with PKCE, or an API key for compatibility.

POST https://api.nexscope.ai/mcp
MCP-Protocol-Version: 2025-11-25
Content-Type: application/json

Authentication

OAuth clients request the mcp:tools scope. The endpoint's 401 response advertises protected-resource metadata for authorization discovery.

Step 2 of 2 · Call the tool

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_shopee_product_search",
    "arguments": {
      "keyword": "phone case",
      "keywordType": 1,
      "page": 1,
      "pageSize": 1000,
      "station": "SG"
    }
  }
}

Legacy MCP v1

Existing API-key clients can continue using the compatibility endpoint. New integrations should use MCP v2.

GET / POST /mcp/legacy

Online test

Execute the current API with your API key and JSON payload. Online tests use this site's configured API environment; the Endpoint and copyable examples use the public integration address.

10 credits / callAPI usage records

Try it

Send a real request with the same contract shown in the reference.

Endpoint

/yy/shopee/getProductInfos

MCP method

nexscope_shopee_product_search

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/yy/shopee/getProductInfos \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "keyword": "Storage Box", "keywordType": 2, "orderBy": "sold", "orderByType": "DESC", "pageSize": 50, "soldMin": 100, "station": "malaysia" }'

Response

No response yet. Run the request to see the response here.

Related APIs

Shopee Product Detail

Retrieve public Shopee product details from a validated marketplace URL.