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 documented response payload.

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 parameters

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

Code example

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

Response example

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

{
  "data": {
    "value": [
      {
        "SearchVolume": 1,
        "Rank": 1,
        "Keyword": "wireless earbuds"
      }
    ],
    "requestConsumed": 1,
    "operation": "searchByName"
  },
  "code": 0,
  "msg": null,
  "ts": "0",
  "time": "2026-01-01 00:00:00",
  "cost": "-1",
  "traceId": null
}

Response fields

Name	Type	Required	Description
`data`	`any`	required	Data value used by this API operation.
`code`	`integer`	required	0 means accepted or successful; nonzero is a platform error.
`msg`	`string \| null`	required	Msg value used by this API operation.
`ts`	`string`	required	Epoch milliseconds.
`time`	`string`	required	Server local time: yyyy-MM-dd HH:mm:ss.
`cost`

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.

Walmart Keyword Research

What this API does

Walmart Keyword Research

What this API does

Authentication

Run an API

Example request

Check the response

HTTP status codes

Run this API

Endpoint

Request parameters

operation: marketQuery

Code example

Response example

Response fields

Responses

Data source, freshness, and limitations

MCP

Call a tool

Legacy MCP v1

Online test

Try it

Related APIs

operation: searchByName

operation: searchProducts

operation: detail

operation: productKeywords

operation: relatedKeywords

operation: favoriteList

One of option 1

One of option 2

Any of option 1 — requires operation, value, requestConsumed

Any of option 2