Nexscope

Shopee Product Research: shopee/get Product Infos API

Use Shopee Product Research: shopee/get Product Infos API through Nexscope with documented parameters, structured results and API key authentication.

CostRecent 10 credits / call
Try online
POST · https://api.nexscope.ai/yy/shopee/getProductInfosMCP · nexscope_data_yy_shopee_get_product_infos
Shopee Product Research

What this API does

Use Shopee Product Research: shopee/get Product Infos API through Nexscope with documented parameters, structured results and API key authentication. The request accepts station, keyword, keywordType, notExistKeyword, notExistKeywordType. Its documented result includes totalSize, sourceType, products, pid, title, description, imageUrl, productUrl.

Shopee Product Research: shopee/get Product Infos API API use cases

Investigate a seller or store

To investigate a seller or store, a marketplace analyst submits station and keyword to Shopee Product Research: shopee/get Product Infos API. The returned totalSize, sourceType, products help identify the store associated with a candidate product.

Compare storefront product evidence

A marketplace analyst uses Shopee Product Research: shopee/get Product Infos API 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 Research: shopee/get Product Infos API with station and keyword to shortlist stores for further research. The result helps choose stores for a supplier or competitor review.

Shopee Product Research: shopee/get Product Infos API API FAQ

What does the Shopee Product Research: shopee/get Product Infos API API return?

Use Shopee Product Research: shopee/get Product Infos API through Nexscope with documented parameters, structured results and API key authentication. 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 Research: shopee/get Product Infos API 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 Research: shopee/get Product Infos API 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_data_yy_shopee_get_product_infos. The same documented request parameters apply; use Online test to review a request before adding it to your app.

View plans and creditsConnect this API with MCP

Try this API
Endpoint
https://api.nexscope.ai/yy/shopee/getProductInfos
MCP method
nexscope_data_yy_shopee_get_product_infos

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

CodeDescription
200HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400Request JSON or required API parameters are invalid.
401API key is missing, invalid, or cannot be matched to a user.
5xxAPI execution or upstream service failed.
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.

Endpoint

MethodPOST
Pathhttps://api.nexscope.ai/yy/shopee/getProductInfos
AuthBearer API key
Content-Typeapplication/json

Request parameters

NameTypeRequiredDescription
stationstringoptional
**Required**. Shopee site, you can pass the name or code. See site mapping table below.
keywordstringoptional
Product title keywords.
keywordTypeintegeroptional
Matching mode: 1=whole sentence (default), 2=multi-word AND, 3=multi-word OR.
notExistKeywordstringoptional
Exclude products containing this keyword.
notExistKeywordTypeintegeroptional
Exclude match patterns: 1=whole sentence (default), 2=multi-word AND, 3=multi-word OR.
priceMinnumberoptional
Total product price starting value (local currency).
priceMaxnumberoptional
The end value of the total price of the product.
soldMinintegeroptional
The starting value of the number of units sold in the previous 30 days.
soldMaxintegeroptional
The end value of the number of units sold in the previous 30 days.
estimateSoldStartintegeroptional
Estimate the starting value of the number of units sold in the first 30 days.
estimateSoldEndintegeroptional
Estimate the end value of the number of units sold in the first 30 days.
historicalSoldStartintegeroptional
The starting value of the total number of units sold of the product.
historicalSoldEndintegeroptional
The end value of the total number of units sold of the product.
paymentStartnumberoptional
The starting value of sales amount in the previous 30 days.
paymentEndnumberoptional
Ending value of sales amount in the previous 30 days.
ratingMinnumberoptional
Minimum product rating (0-5).
ratingMaxnumberoptional
Maximum product rating.
ratingsMinintegeroptional
The starting value of the score.
ratingsMaxintegeroptional
The end value of the score.
favoriteMinintegeroptional
The starting value of the number of collections.
favoriteMaxintegeroptional
End value of collection count.
skuNumberStartintegeroptional
Starting value of the total number of SKUs.
skuNumberEndintegeroptional
The end value of the total number of SKUs.
listingDateFromstringoptional
The starting value of product shelf time (format: yyyy-MM-dd).
listingDateTostringoptional
Product shelf end value (format: yyyy-MM-dd).
statTimeStartstringoptional
Starting value of statistical time (format: yyyy-MM-dd HH:mm:ss).
statTimeEndstringoptional
End value of statistical time (format: yyyy-MM-dd HH:mm:ss).
lastModiTimeStartstringoptional
The latest crawl time starting value (format: yyyy-MM-dd).
lastModiTimeEndstringoptional
The latest crawl time end value (format: yyyy-MM-dd).
approvedDateStartstringoptional
The starting value of the store opening time (format: yyyy-MM-dd).
approvedDateEndstringoptional
The end value of the store opening time (format: yyyy-MM-dd).
pL1Idstringoptional
Level 1 category ID.
pL2Idstringoptional
Level 2 category ID.
pL3Idstringoptional
Level 3 category ID.
cidListstringoptional
Category id list, complete path, multiple groups separated by `|`, such as: `AAA,BBB,CCC|DDD,EEE`.
shopIdListstringoptional
Specify a list of store IDs, separated by multiple commas.
notExistShopIdListstringoptional
Exclude a list of store IDs, separated by multiple commas.
merchantstringoptional
Store name or user name.
shopLocationstringoptional
Store location.
shippingIconTypeintegeroptional
Store location: 0=local, 1=overseas.
cbOptionintegeroptional
Shipping location: 0=domestic, 1=cross-border.
isShopeeVerifiedintegeroptional
Shopee Preferred: 0=not preferred, 1=preferred.
isOfficialShopintegeroptional
Official store: 0=no, 1=yes.
isHotSalesintegeroptional
Whether it is a hot seller: 0 = not a hot seller, 1 = a hot seller.
pidsstringoptional
List of product IDs (up to 500), separated by commas.
orderBystringoptional
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).
orderByTypestringoptional
Sorting direction: `ASC` (ascending order), `DESC` (descending order).
Example: DESC
pageintegeroptional
Page number (starting from 1).
Example: 1
pageSizeintegeroptional
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)

NameTypeRequiredDescription
totalintegeroptional
The current number of records returned.
totalSizeintegeroptional
Total number of results.
sourceTypestringoptional
Source type: `shopee`.
columnsarrayoptional
Render column definitions.
costTokenintegeroptional
Consume token.
typestringoptional
Rendering style.
productsarrayoptional
List of products (see fields below).
pidstringoptional
Product unique ID.
titlestringoptional
Product title.
descriptionstringoptional
Product description.
imageUrlstringoptional
Product main image URL.
productUrlstringoptional
Shopee product link.
shopeeUrlstringoptional
Product links under the Shopee domain name.
pricenumberoptional
Product default price (local currency).
minPricenumberoptional
SKU lowest price.
maxPricenumberoptional
The highest price of the SKU.
soldintegeroptional
Number of units sold in the previous 30 days.
estimateSoldintegeroptional
Estimate the number of units sold in the previous 30 days.
historicalSoldintegeroptional
The total number of items sold.
paymentnumberoptional
Sales in the previous 30 days (local currency).
ratingnumberoptional
Product rating (0-5).
ratingsintegeroptional
Rating number.
favoriteintegeroptional
Number of collections.
viewCountintegeroptional
Number of views.
stockintegeroptional
Stock count.
skuNumberintegeroptional
SKU quantity.
genTimestringoptional
Shelf time.
statTimestringoptional
Statistics time.
lastModiTimestringoptional
Latest crawl time.
categoryStructurestringoptional
Category structure path.
cidstringoptional
Category IDs (comma separated).
shopIdstringoptional
Store ID.
shopNamestringoptional
Store name.
shopUrlstringoptional
Store link.
userNamestringoptional
Store owner name.
shopLocationstringoptional
Store location.
shopProductsCountintegeroptional
The total number of items in the store.
approvedDatestringoptional
Store opening hours.
isOfficialShopintegeroptional
Is it an official store (1=yes, 0=no).
isShopeeVerifiedintegeroptional
Shopee is preferred (1=yes, 0=no).
isHotSalesintegeroptional
Is it a hot seller (1=yes, 0=no).
shippingIconTypeintegeroptional
Store location type (0=local, 1=overseas, 3 or null=unknown).
cbOptionintegeroptional
Shipping location (0=domestic, 1=cross-border).
estimatedDaysintegeroptional
Estimated days of arrival.
statusintegeroptional
Product status (1=normal, 0=removed, 8=excluded from list).
notExistintegeroptional
Whether it exists (0=exists, 1=does not exist).

Responses

CodeDescription
200HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400Request JSON or required API parameters are invalid.
401API key is missing, invalid, or cannot be matched to a user.
5xxAPI 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_data_yy_shopee_get_product_infos",
    "arguments": {
      "keyword": "Storage Box",
      "keywordType": 2,
      "orderBy": "sold",
      "orderByType": "DESC",
      "pageSize": 50,
      "soldMin": 100,
      "station": "malaysia"
    }
  }
}

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_data_yy_shopee_get_product_infos
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