POST
https://api.nexscope.ai/st/walmart/keywordResearchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/st/walmart/keywordResearch |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
No required request fields are defined for this API.
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (73 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Gateway framework layer status code; `200` indicates that the request successfully entered the business response |
errmsg | string | optional | Gateway framework layer status message; typically `ok` on success |
code | integer | optional | `200` indicates success |
msg | string | optional | Response message; when there is no data, it may be "query successful, but no data" |
data | object | optional | Fixed response container; actual business results are in `data.value` |
operation | string | optional | The actual operation performed this time |
requestConsumed | integer | optional | 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 |
costTime | integer | optional | Time taken, unit is milliseconds |
costToken | integer / absent | optional | 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. |
costCredit | integer / absent | optional | 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 |
sourceType | string | optional | `st` |
marketQuery | array<object> | optional | keyword summary array |
searchByName | array<object> | optional | Keyword summary array related to product or category name |
searchProducts | array<object> | optional | Product summary array in search results for the keyword in the past 15 days |
detail | object | optional | Single keyword summary object |
productKeywords | array<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 |
relatedKeywords | array<object> | optional | Related keyword summary array |
favoriteAdd | integer | optional | Favorite result code |
favoriteChange | integer | optional | Delete or move result codes |
favoriteList | array<string> | optional | Array of keywords or directory names, the specific content is determined by `command` |
Keyword | string | optional | keywords |
KeywordCNName | string | optional | Keyword Chinese name |
Images | array<string> | optional | Keyword search results Top 10 product image URL |
Update | string | optional | Keyword last updated time, usually `yyyyMMdd` |
Rank | integer | optional | Weekly search ranking |
SearchVolume | number | optional | Last 30 days search volume; may be transmitted by upstream as a JSON number with decimals |
ProductCount | integer | optional | Number of competing products displayed on Walmart search page |
SearchFirstPageAvgPrice | integer | optional | The average price of natural products on the first page of search results; the unit on the US site is cents |
SearchFirstPageAvgReviews | number | optional | Average number of reviews for natural products on the first page of search results |
SearchFirstPageAvgStar | number | optional | Average rating of natural products on the first page of search results |
ShowShare | number | optional | The proportion of exposure traffic this keyword brings to the product |
RecentlyPosition | string | optional | The most recently exposed position, such as `1,2/18` means page 1, position 2, 18 positions in total |
OrganicPosition | string | optional | The most recent natural exposure position, the encoding is the same as `RecentlyPosition` |
AdPosition | string | optional | The most recent ad exposure position, coded the same as `RecentlyPosition` |
Keyword | object | optional | Complete keyword summary object; see "Keyword Summary Field" for fields |
Title | string | optional | Product title |
Photo | array<string> | optional | Product image URL array |
ListingSalesVolumeOfMonth | integer | optional | Estimated sales volume in the last 30 days in the Listing dimension, without distinguishing between variants |
ListingSalesOfMonth | integer | optional | Estimated sales in the past 30 days in the Listing dimension; the unit for the US site is cents |
ProductId | string | optional | Walmart ProductId |
ParentProductId | string | optional | Parent product ProductId |
Price | integer | optional | Selling price; the US site unit is cents, such as `1999` means `$19.99` |
Brand | string | optional | brand |
Seller | string | optional | Seller name at the time of collection |
Shipedby | string | optional | The delivery method at the time of collection; the field name is the original spelling of the upstream |
WFSFee | integer | optional | WFS fee; US site unit is cents |
Attribute | array<string> / null | optional | Product attributes, interleaved encoding according to `[attribute name, attribute value, ...]` |
FirstReviewsDate | string / null | optional | Date of first comment in the format `yyyy-MM-dd` |
ReviewsCount | integer | optional | Number of comments |
Ratings | number | optional | Rating, like `4.8` |
NodePath | array<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` |
Label | array<string> | optional | Product tags, such as `pickup`, `savewith`, `bestsell` |
PopularPick | integer | optional | Popular Pick tag; `1` indicates existence |
Clearance | integer | optional | Clearance tag; `1` indicates existence |
ReducedPrice | integer | optional | Reduced Price tag; `1` indicates existence |
Rollback | integer | optional | Rollback token; `1` indicates existence |
FlashDeal | integer | optional | Flash Deal tag; `1` indicates existence |
Size | array<string> / null | optional | Outer packaging size `[longest side, second longest side, shortest side]`, unit is cm |
Weight | number | optional | Product weight in grams |
Variants | array<object> / null | optional | Variation list, fields are shown in the table below |
NumberOfStar | array<number\|string> / null | optional | The number of reviews for each star rating, according to `[star rating, number of reviews, ...]` staggered coding |
VariantId | string | optional | Variant ProductId |
Url | string | optional | Variant product URL |
Property | array<string> | optional | Variant attributes, encoded by `[attribute name, attribute value, ...]` |
PriceUpdate | string / null | optional | Price update time, usually `yyyy-MM-dd` |
DetailUpdate | string / null | optional | 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 |
favoriteList | array<string> | optional | `dict` returns the directory name; `all` or `dict=<directory>` returns the keyword |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
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.