Walmart Keyword Research API

REST API and MCP service documentation generated from server-side API definitions. Responses shown here are the direct payload returned by each API execution.

API selector

Walmart Marketplace Intelligence

API overview

Research Walmart keyword markets, matching products, keyword details, related terms, product keywords, and saved dictionaries safely.

Try this API

Endpoint

https://api.nexscope.ai/api/skill-api/v1/skills/walmart-keyword-research/run

MCP method

nexscope_walmart_keyword_research

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 .

POSThttps://api.nexscope.ai/api/skill-api/v1/skills/walmart-keyword-research/run

Run an API

Send a JSON request body using the parameters described below.

Slug	`walmart-keyword-research`
Headers	`Authorization: Bearer nk_...` `Content-Type: application/json`
Request body	API-specific JSON object.
Response body	Direct API response payload. No data/result wrapper is added.

Status codes

Code	Description
200	API executed successfully. Body is the direct response payload.
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.

Example request

curl -X POST https://api.nexscope.ai/api/skill-api/v1/skills/walmart-keyword-research/run \
  -H "Authorization: Bearer nk_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{   "operation": "searchByName",   "name": "wireless earbuds",   "pageIndex": 1 }'

All categories/ Walmart Marketplace Intelligence

POSThttps://api.nexscope.ai/api/skill-api/v1/skills/walmart-keyword-research/run

Run this API

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

Open tester

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/api/skill-api/v1/skills/walmart-keyword-research/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request body

operation: marketQuery

Name	Type	Required	Description
`operation`	`string`	required	Walmart keyword research operation Constant: marketQuery
`pattern`	`object`	optional	Optional marketQuery filter object
`pattern.keyword`	`string`	optional	Keyword filter inside pattern Minimum length: 1
`pattern.rankCondition`	`array`	optional	One- or two-value rank range Minimum items: 1 Maximum items: 2
`pattern.rankCondition[]`	`integer`	required	One- or two-value rank range Minimum: 0
`pattern.searchVolumeCondition`	`array`	optional	One- or two-value search-volume range Minimum items: 1 Maximum items: 2
`pattern.searchVolumeCondition[]`	`integer`	required	One- or two-value search-volume range Minimum: 0
`pageIndex`	`integer`	optional	Page number, starting at 1 Default: 1 Minimum: 1
`pageSize`	`integer`	optional	Page size from 20 to 200 Default: 20 Minimum: 20 Maximum: 200

operation: searchByName

Name	Type	Required	Description
`operation`	`string`	required	Walmart keyword research operation Constant: searchByName
`name`	`string`	required	Keyword name required by searchByName Minimum length: 1
`pageIndex`	`integer`	optional	Page number, starting at 1 Default: 1 Minimum: 1

operation: searchProducts

Name	Type	Required	Description
`operation`	`string`	required	Walmart keyword research operation Constant: searchProducts
`keyword`	`string`	required	Keyword required by searchProducts, detail, or relatedKeywords Minimum length: 1
`pageIndex`	`integer`	optional	Page number, starting at 1 Default: 1 Minimum: 1
`pageSize`	`integer`	optional	Page size from 20 to 200 Default: 20 Minimum: 20 Maximum: 200

operation: detail

Name	Type	Required	Description
`operation`	`string`	required	Walmart keyword research operation Constant: detail
`keyword`	`string`	required	Keyword required by searchProducts, detail, or relatedKeywords Minimum length: 1

operation: productKeywords

Name	Type	Required	Description
`operation`	`string`	required	Walmart keyword research operation Constant: productKeywords
`productId`	`string`	required	Product ID required by productKeywords Minimum length: 1
`pageIndex`	`integer`	optional	Page number, starting at 1 Default: 1 Minimum: 1
`pageSize`	`integer`	optional	Page size from 20 to 200 Default: 20 Minimum: 20 Maximum: 200

operation: relatedKeywords

Name	Type	Required	Description
`operation`	`string`	required	Walmart keyword research operation Constant: relatedKeywords
`keyword`	`string`	required	Keyword required by searchProducts, detail, or relatedKeywords Minimum length: 1
`pageIndex`	`integer`	optional	Page number, starting at 1 Default: 1 Minimum: 1
`pageSize`	`integer`	optional	Page size from 20 to 200 Default: 20 Minimum: 20 Maximum: 200

operation: favoriteList

Name	Type	Required	Description
`operation`	`string`	required	Walmart keyword research operation Constant: favoriteList
`command`	`any`	required	Read-only favoriteList command: all, dict, or dict=<value>
`pageIndex`	`integer`	optional	Page number, starting at 1 Default: 1 Minimum: 1

One of option 1

Name	Type	Required	Description
`command`	`any`	required	Read-only favoriteList command: all, dict, or dict=<value> Allowed: all, dict

One of option 2

Name	Type	Required	Description
`command`	`string`	required	Read-only favoriteList command: all, dict, or dict=<value> Pattern: ^dict=.+$

Request example

{
  "operation": "searchByName",
  "name": "wireless earbuds",
  "pageIndex": 1
}

Response body

Name	Type	Required	Description
`operation`	`any`	required	Operation value used by this API operation.
`value`	`any`	required	Value value used by this API operation.
`requestConsumed`	`integer`	required	Request consumed value used by this API operation. Minimum: 0

One of option 1

Name	Type	Required	Description
`operation`	`any`	optional	Operation value used by this API operation. Allowed: marketQuery, searchByName, searchProducts, productKeywords, relatedKeywords, favoriteList
`value`	`array`	optional	Value value used by this API operation.

operation: detail

Name	Type	Required	Description
`operation`	`string`	optional	Operation value used by this API operation. Constant: detail
`value`	`object`	optional	Value value used by this API operation.

Response example

Direct response payload. No extra wrapper is added.

{
  "operation": "searchByName",
  "requestConsumed": 1,
  "value": [
    {
      "Keyword": "wireless earbuds",
      "Rank": 1,
      "SearchVolume": 1
    }
  ]
}

Responses

Code	Description
200	API executed successfully. Body is the direct response payload.
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.

Related APIs

Walmart Category Market API

Research Walmart category trees, search category names, and retrieve category market reports through three governed read-only operations.

Walmart Product Analysis API

Analyze Walmart products, detail records, performance trends, and dated sales volume while preserving long product identifiers as strings.

Walmart Product Detail API

Query Walmart product details through WallySmarter, including pricing history and sales trends. View request parameters, response fields, and MCP usage.

Walmart Search API

Search Walmart product listings by keyword, category, price range, and other filters. Review request and response fields.

MCP

Use the MCP endpoint when an agent needs to discover and call API tools with JSON-RPC.

GET /api/skill-api/v1/mcp

POST /api/skill-api/v1/mcp
Authorization: Bearer nk_xxxxxxxxxxxxxxxxx
Content-Type: application/json

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_walmart_keyword_research",
    "arguments": {
      "operation": "searchByName",
      "name": "wireless earbuds",
      "pageIndex": 1
    }
  }
}

Online test

Execute the current API with your API key and JSON payload.

Try it

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

Endpoint

https://api.nexscope.ai/api/skill-api/v1/skills/walmart-keyword-research/run

MCP method

nexscope_walmart_keyword_research

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/api/skill-api/v1/skills/walmart-keyword-research/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "operation": "searchByName", "name": "wireless earbuds", "pageIndex": 1 }'

Response

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