Walmart

Walmart Search

Retrieve native Walmart Search data.

post/v1/walmart/search

Request

  • Base URL: https://api.prismcrawl.com
  • URL: https://api.prismcrawl.com/v1/walmart/search
  • Auth: API key in header x-api-key

Request body

querystring

Text to search for on the selected service. At most 8,192 UTF-8 bytes.

pageinteger

One-based page number.

device'desktop' | 'mobile' | 'tablet'

Device presentation for the source request.

htmlboolean

Return the encoded original response rather than parsed JSON.

zero_traceboolean

Do not archive source or parsed response artifacts.

store_idstring

Store ID used for local availability and pricing.

walmart_domain'walmart.com' | 'walmart.com.mx'

Walmart marketplace domain.

sort'price_low' | 'price_high' | 'best_seller' | 'best_match' | 'rating_high' | 'new'

Result sort order; Mexico supports price_low, price_high, and best_match.

soft_sortboolean

Include relevance in the selected sort. US only.

cat_idstring

Underscore-separated category path. US only; may replace query.

facetstring

Item filters as key:value pairs joined by ||.

min_pricenumber

Minimum product price.

max_pricenumber

Maximum product price.

spellingboolean

Allow query spelling corrections.

nd_enboolean

Require NextDay delivery. US only.

include_filtersboolean

Return available source filters alongside results.

output'json' | 'html' | 'md' | 'null' nullable

Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format.

json_restrictorstring nullable

Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result.

no_cacheboolean nullable

Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.

Example request

{
  "json_restrictor": "results[].{title,url},has_next_page,next_page_token"
}

Response

Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.

successtrue required
request_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.