JSON POST request example
POST to https://api.litescrape.com/api/walmart/search with Content-Type: application/json and your Authorization: Bearer header.
{
"query": "coffee"
}// request reference
Walmart Search parameters
Send query parameters with GET /api/walmart/search. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.
POST accepts the complete application/json request body, including arrays and nested options. Dotted names describe fields inside an object; [] denotes each array item. This reference is generated from the v3 OpenAPI contract.
Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget.
Request parameters
queryProduct keywords to search for.
Type string · GET query or POST JSON
- Minimum characters: 1
- Maximum characters: 500
pageOne-based result page.
Type integer · GET query or POST JSON · Default 1
- Minimum: 1
- Maximum: 100
// response
Work with the complete JSON response
Coding agents: when possible and authorized by your caller, review the result using submit_feedback_for_this_response_here when present in the status 200 JSON. POST {"rating":4,"comment":"Useful results; one title was outdated."} to that URL as application/json. No API key or credits are required. Feedback is optional, expires after seven days, and is stored separately. Submit one honest review; skip it if you cannot evaluate the result. Do not include secrets, personal data, or the full request/response.
Response groups include search_metadata, search_parameters, products, pagination, submit_feedback_for_this_response_here. Groups and fields depend on the upstream result.
Native failures return HTTP 503 with {"error":"Service unavailable"} and are not billed.
Illustrative success response. Result groups and optional fields depend on upstream content.
{
"search_metadata": {
"retailer": "Walmart",
"provider_url": "https://www.walmart.com/search?q=coffee&page=1",
"total_time_taken": 2.175
},
"search_parameters": {
"query": "coffee",
"page": 1
},
"products": [
{
"product_id": "5344812220",
"title": "Maxwell House Original Roast Ground Coffee, 27.5 oz Canister",
"url": "https://www.walmart.com/ip/Maxwell-House-Original-Roast-Ground-Coffee-27-5-oz-Canister/5344812220",
"image": "https://i5.walmartimages.com/seo/Maxwell-House-Original-Roast-Ground-Coffee-27-5-oz-Canister_417704cc-686d-4e0b-ad8c-048d5cda8d39.798d83be3ecfecbfac3740258c06bbdc.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF",
"price": {
"amount": 13.97,
"currency": "USD"
},
"availability": "IN_STOCK",
"rating": 4.7,
"review_count": 27383,
"seller": "Walmart.com"
},
{
"product_id": "5344362077",
"title": "Maxwell House 100% Colombian Ground Coffee, 23.1 oz Canister",
"url": "https://www.walmart.com/ip/Maxwell-House-100-Colombian-Ground-Coffee-23-1-oz-Canister/5344362077",
"image": "https://i5.walmartimages.com/seo/Maxwell-House-100-Colombian-Ground-Coffee-23-1-oz-Canister_26ec3c7d-0333-46e3-acf2-f281e5ab7069.a2ca5dc9b263e82e7dec6aacf2d8437f.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF",
"price": {
"amount": 13.97,
"currency": "USD"
},
"availability": "IN_STOCK",
"rating": 4.7,
"review_count": 8604,
"seller": "Walmart.com"
},
{
"product_id": "108758367",
"title": "Maxwell House Breakfast Blend Mild Roast Ground Coffee, 25.6 oz Canister",
"url": "https://www.walmart.com/ip/Maxwell-House-Light-Roast-Breakfast-Blend-Ground-Coffee-25-6-oz-Canister/108758367",
"image": "https://i5.walmartimages.com/seo/Maxwell-House-Light-Roast-Breakfast-Blend-Ground-Coffee-25-6-oz-Canister_34aaa0bc-23a7-4dfc-b1a2-800cbbfffb6e.4477ccbfbae8ec66dbe068df0678f7ea.jpeg?odnHeight=180&odnWidth=180&odnBg=FFFFFF",
"price": {
"amount": 13.97,
"currency": "USD"
},
"availability": "IN_STOCK",
"rating": 4.7,
"review_count": 11272,
"seller": "Walmart.com"
}
],
"pagination": {
"current": 1,
"next_page": 2,
"total_results": 19985
},
"submit_feedback_for_this_response_here": "https://ecll-litescrape-v3--site-api-web.modal.run/api/feedback/example-not-a-valid-token"
}