Nexscope

Walmart Intelligence ST: walmart/keyword Research API

Use Walmart Intelligence ST: walmart/keyword Research API through Nexscope with documented parameters, structured results and API key authentication.

CostRecent Avg. 34 · Range 13–63 credits / call
Try online
POST · https://api.nexscope.ai/st/walmart/keywordResearchMCP · nexscope_data_st_walmart_keyword_research
Walmart Intelligence ST

What this API does

Use Walmart Intelligence ST: walmart/keyword Research API through Nexscope with documented parameters, structured results and API key authentication. Its documented result includes errcode, errmsg, requestConsumed, costCredit, sourceType, marketQuery, searchByName, searchProducts.

Walmart Intelligence ST: walmart/keyword Research API API use cases

Build a keyword shortlist

To build a keyword shortlist, a marketplace analyst submits the operation-specific inputs to Walmart Intelligence ST: walmart/keyword Research API. The returned errcode, errmsg, requestConsumed help choose candidate search terms for further investigation.

Compare search demand signals

A marketplace analyst uses Walmart Intelligence ST: walmart/keyword Research API with the operation-specific inputs to compare search demand signals. The returned errcode, errmsg, requestConsumed help compare keyword demand within the requested market scope.

Plan a content or advertising test

For this workflow, a marketplace analyst calls Walmart Intelligence ST: walmart/keyword Research API with the operation-specific inputs to plan a content or advertising test. The result helps select terms for a content or advertising experiment.

Walmart Intelligence ST: walmart/keyword Research API API FAQ

What does the Walmart Intelligence ST: walmart/keyword Research API API return?

Use Walmart Intelligence ST: walmart/keyword Research API through Nexscope with documented parameters, structured results and API key authentication. The documented output includes errcode, errmsg, requestConsumed, costCredit, sourceType, marketQuery, searchByName, searchProducts. 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 Walmart Intelligence ST: walmart/keyword Research API API cost?

The current documented cost is Recent Avg. 34 · Range 13–63 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 Walmart Intelligence ST: walmart/keyword Research API API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/st/walmart/keywordResearch 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_st_walmart_keyword_research. 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/st/walmart/keywordResearch
MCP method
nexscope_data_st_walmart_keyword_research

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/st/walmart/keywordResearch

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/st/walmart/keywordResearch' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "operation": "marketQuery",
  "pageIndex": 1,
  "pageSize": 20,
  "pattern": {
    "keyword": "wireless"
  }
}'

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/ Walmart Intelligence ST
POSThttps://api.nexscope.ai/st/walmart/keywordResearch

Run this API

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

Endpoint

MethodPOST
Pathhttps://api.nexscope.ai/st/walmart/keywordResearch
AuthBearer API key
Content-Typeapplication/json

Request parameters

No required request fields are defined for this API.

Code example

{
  "operation": "marketQuery",
  "pageIndex": 1,
  "pageSize": 20,
  "pattern": {
    "keyword": "wireless"
  }
}

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 (73 fields)

NameTypeRequiredDescription
errcodeintegeroptional
Gateway framework layer status code; `200` indicates that the request successfully entered the business response
errmsgstringoptional
Gateway framework layer status message; typically `ok` on success
codeintegeroptional
`200` indicates success
msgstringoptional
Response message; when there is no data, it may be "query successful, but no data"
dataobjectoptional
Fixed response container; actual business results are in `data.value`
operationstringoptional
The actual operation performed this time
requestConsumedintegeroptional
This upstream consumption; when the upstream is missing or returns 0, it is completed according to the document consumption of the operation; when ST explicitly returns `Code=11`, it remains 0
costTimeintegeroptional
Time taken, unit is milliseconds
costTokeninteger / absentoptional
Production gateway response header `X-Cost-Token`; the entry script will be copied to this field, and this field is currently missing when parsing the JSON body directly.
costCreditinteger / absentoptional
Production gateway response header `X-Cost-Credit`, which is the actual computing power deducted this time; the entry script will be copied to this field
sourceTypestringoptional
`st`
marketQueryarray<object>optional
keyword summary array
searchByNamearray<object>optional
Keyword summary array related to product or category name
searchProductsarray<object>optional
Product summary array in search results for the keyword in the past 15 days
detailobjectoptional
Single keyword summary object
productKeywordsarray<object>optional
Records of the keywords that the product has been exposed on the first three pages of search results in the past 30 days
relatedKeywordsarray<object>optional
Related keyword summary array
favoriteAddintegeroptional
Favorite result code
favoriteChangeintegeroptional
Delete or move result codes
favoriteListarray<string>optional
Array of keywords or directory names, the specific content is determined by `command`
Keywordstringoptional
keywords
KeywordCNNamestringoptional
Keyword Chinese name
Imagesarray<string>optional
Keyword search results Top 10 product image URL
Updatestringoptional
Keyword last updated time, usually `yyyyMMdd`
Rankintegeroptional
Weekly search ranking
SearchVolumenumberoptional
Last 30 days search volume; may be transmitted by upstream as a JSON number with decimals
ProductCountintegeroptional
Number of competing products displayed on Walmart search page
SearchFirstPageAvgPriceintegeroptional
The average price of natural products on the first page of search results; the unit on the US site is cents
SearchFirstPageAvgReviewsnumberoptional
Average number of reviews for natural products on the first page of search results
SearchFirstPageAvgStarnumberoptional
Average rating of natural products on the first page of search results
ShowSharenumberoptional
The proportion of exposure traffic this keyword brings to the product
RecentlyPositionstringoptional
The most recently exposed position, such as `1,2/18` means page 1, position 2, 18 positions in total
OrganicPositionstringoptional
The most recent natural exposure position, the encoding is the same as `RecentlyPosition`
AdPositionstringoptional
The most recent ad exposure position, coded the same as `RecentlyPosition`
Keywordobjectoptional
Complete keyword summary object; see "Keyword Summary Field" for fields
Titlestringoptional
Product title
Photoarray<string>optional
Product image URL array
ListingSalesVolumeOfMonthintegeroptional
Estimated sales volume in the last 30 days in the Listing dimension, without distinguishing between variants
ListingSalesOfMonthintegeroptional
Estimated sales in the past 30 days in the Listing dimension; the unit for the US site is cents
ProductIdstringoptional
Walmart ProductId
ParentProductIdstringoptional
Parent product ProductId
Priceintegeroptional
Selling price; the US site unit is cents, such as `1999` means `$19.99`
Brandstringoptional
brand
Sellerstringoptional
Seller name at the time of collection
Shipedbystringoptional
The delivery method at the time of collection; the field name is the original spelling of the upstream
WFSFeeintegeroptional
WFS fee; US site unit is cents
Attributearray<string> / nulloptional
Product attributes, interleaved encoding according to `[attribute name, attribute value, ...]`
FirstReviewsDatestring / nulloptional
Date of first comment in the format `yyyy-MM-dd`
ReviewsCountintegeroptional
Number of comments
Ratingsnumberoptional
Rating, like `4.8`
NodePatharray<string\|null>optional
Category and ranking records are grouped and coded according to `[category name, NodeId, ranking date, ranking, ...]`; when the ranking on a certain day is missing, the corresponding position is `null`
Labelarray<string>optional
Product tags, such as `pickup`, `savewith`, `bestsell`
PopularPickintegeroptional
Popular Pick tag; `1` indicates existence
Clearanceintegeroptional
Clearance tag; `1` indicates existence
ReducedPriceintegeroptional
Reduced Price tag; `1` indicates existence
Rollbackintegeroptional
Rollback token; `1` indicates existence
FlashDealintegeroptional
Flash Deal tag; `1` indicates existence
Sizearray<string> / nulloptional
Outer packaging size `[longest side, second longest side, shortest side]`, unit is cm
Weightnumberoptional
Product weight in grams
Variantsarray<object> / nulloptional
Variation list, fields are shown in the table below
NumberOfStararray<number\|string> / nulloptional
The number of reviews for each star rating, according to `[star rating, number of reviews, ...]` staggered coding
VariantIdstringoptional
Variant ProductId
Urlstringoptional
Variant product URL
Propertyarray<string>optional
Variant attributes, encoded by `[attribute name, attribute value, ...]`
PriceUpdatestring / nulloptional
Price update time, usually `yyyy-MM-dd`
DetailUpdatestring / nulloptional
Details update time, usually `yyyy-MM-dd`; when there is no valid date, upstream placeholders such as `--` may be used
operation`data.value`optional
Description
favoriteAdd`0`optional
Collection successful
favoriteAdd`1`optional
Keyword already exists
favoriteAdd`9`optional
Collection failed
favoriteChange`0`optional
Delete or move successfully
favoriteChange`9`optional
Keyword does not exist
favoriteListarray<string>optional
`dict` returns the directory name; `all` or `dict=<directory>` returns the keyword

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_st_walmart_keyword_research",
    "arguments": {
      "operation": "marketQuery",
      "pageIndex": 1,
      "pageSize": 20,
      "pattern": {
        "keyword": "wireless"
      }
    }
  }
}

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.

At least 10 credits / callAPI usage records

Try it

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

Endpoint
/st/walmart/keywordResearch
MCP method
nexscope_data_st_walmart_keyword_research
cURL
curl -X POST \
  https://api.nexscope.ai/st/walmart/keywordResearch \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "operation": "marketQuery", "pageIndex": 1, "pageSize": 20, "pattern": { "keyword": "wireless" } }'
Response
No response yet. Run the request to see the response here.

Related APIs