Piloterr

Walmart Search

GET
/v2/walmart/search

Scrape Walmart.com search result pages from a full URL and retrieve product cards with pricing, ratings, availability, and pagination via browser rendering.

Credit cost: 2 credits per call

Autorización

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Parámetros de consulta

query*string

Full Walmart search results URL.

Example (keyword search):

https://www.walmart.com/search?q=apples

Example (page 2):

https://www.walmart.com/search?q=apples&page=2

Notes:

  • Copy the full URL from walmart.com after running a search.
  • Supports keyword queries (q=), pagination (page=), and facet filters.
  • Walmart search pages are JavaScript SPAs; this endpoint uses browser rendering.
  • Pass each result url to the Walmart Product endpoint for full PDP data.
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Cuerpo de la respuesta

Successful response

application/json
  1. response
results?array<>
pagination?
Example Request
curl -X GET 'https://api.piloterr.com/v2/walmart/search?query=string'
Example Response
{  "results": [    {      "id": "40KH71FS6S1U",      "url": "https://www.walmart.com/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096?classType=REGULAR",      "name": "Fresh Rockit, Crisp Sweet Miniature Apples, 3lb Tub",      "type": "REGULAR",      "brand": null,      "image": "https://i5.walmartimages.com/seo/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub_de6d6d44-507a-43e4-9bd9-d86286473870.4d6dbcb5c200885859982510d4314077.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF",      "price": 8.97,      "price_info": {        "unit_price": "$2.99/lb",        "line_price_display": "$8.97"      },      "us_item_id": "309762096",      "seller_name": "Walmart.com",      "canonical_url": "/ip/Fresh-Rockit-Crisp-Sweet-Miniature-Apples-3lb-Tub/309762096?classType=REGULAR",      "average_rating": 4.4,      "fulfillment_type": "STORE",      "is_sponsored_flag": true,      "number_of_reviews": 2034,      "availability_status_v2": {        "value": "IN_STOCK",        "display": "In stock"      }    },    {      "id": "2GZTW48YO9IV",      "url": "https://www.walmart.com/ip/Fresh-Envy-Apples-3-lb-Bag/978115165?classType=REGULAR",      "name": "Fresh Envy™ Apples, 3 lb Bag",      "type": "REGULAR",      "brand": null,      "image": "https://i5.walmartimages.com/seo/Fresh-Envy-Apples-3-lb-Bag_d988dbde-f74a-4fde-a66f-b96569f9133b.87d9427485c1e5d8b3feaf0c0fde5834.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF",      "price": 5.37,      "price_info": {        "unit_price": "$1.79/lb",        "line_price_display": "$5.37"      },      "us_item_id": "978115165",      "seller_name": "Walmart.com",      "canonical_url": "/ip/Fresh-Envy-Apples-3-lb-Bag/978115165?classType=REGULAR",      "average_rating": 4.2,      "fulfillment_type": "STORE",      "is_sponsored_flag": true,      "number_of_reviews": 1172,      "availability_status_v2": {        "value": "IN_STOCK",        "display": "In stock"      }    }  ],  "pagination": {    "next": true,    "page": 1,    "total": 92,    "max_page": 5  }}