Walmart Search API

Api Details

EndpointGET https://serpapi.abcproxy.com/search

Description

/search?engine=walmart API endpoint allows you to scrape the results from the Walmart search engine via our SerpApi service. Head to the playground for a live and interactive demo.


Request

HTTP Request

curl -X GET "https://serpapi.abcproxy.com/search" \
  -d "engine=walmart" \
  -d "query=Coffee" \
  -d "no_cache=false" \
  -d "api_key=YOUR_API_KEY"

API Parameters

Search Query

Name
Type
Required
Description
Example

query

String

Yes

Parameter defines the search query. You can use anything that you would use in a regular Walmart search. Either a query or a cat_id parameter is required.

Coffee

Advanced Walmart Parameters

Name
Type
Required
Description
Example

sort

String

No

Parameter defines sorting. (e.g. price_low, price_high, best_seller, best_match, rating_high, new)

price_low

soft_sort

boolean

No

Parameter enables sort by relevance. Walmart is by default showing results sorted by relevance and using the sort option. Set to false to disable sort by Relevance.

false

Advanced Filters

Name
Type
Required
Description
Example

cat_id

string

No

Category on Walmart Search. (e.g. 0 (default) is all departments, 976759_976787 is 'Cookies', etc.). Either a query or a cat_id parameter is required.

976759_976787

facet

string

No

Parameter defines items filtering based on their attributes. The structure is a list of key:value pairs separated by `

store_id

string

No

Store ID to filter the products by the specific store only. Head to the Walmart Stores Locations for a full list of supported stores.

trueorfalse

min_price

string

No

Lower bound of price range query.

1

max_price

string

No

Upper bound of price range query.

999

spelling

boolean

No

Activate spelling fix. true (default) includes spelling fix, false searches without spelling fix.

trueorfalse

nd_en

boolean

No

Show results with NextDay delivery only. Set to true to enable or false (default) to disable

trueorfalse

Advanced Walmart Parameters

Name
Type
Required
Description
Example

page

String

No

Value is used to get the items on a specific page. (e.g., 1 (default) is the first page of results, 2 is the 2nd page of results, 3 is the 3rd page of results, etc.). Maximum page value is 100.

1

Serpapi Parameters

Name
Type
Required
Description
Example

engine

String

Yes

Set parameter to walmart to use the Google Finance API engine.

walmart

no_cache

boolean

No

Parameter will force SerpApi to fetch the results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to false (default) to allow results from the cache, or true to disallow results from the cache.

trueorfalse

api_key

string

Yes

Parameter defines the SerpApi private key to use.

123


Response

Success 200

Response Body

Response Fields

Field
Type
Description

search_parameters

Object

Contains query parameters and search context

search_metadata

Object

Contains timing and status information

url

string

url


Error Responses

Common Errors

HTTP Status
Error Code
Description

200

400

API Key can not be empty

200

401

Param error

200

402

API Key error

200

403

Insufficient Balance

200

404

Deduction failed

200

405

Failed to record usage count

200

406

Unsupported engine

200

407

Network error

200

408

File not found

200

409

Limit param error

200

410

Build url error

200

411

Failed to QueryRecentRecord

200

412

Failed to find json

200

413

Get html error

200

414

HTML is empty

200

429

Too many request

Error Example


Last updated