Walmart API
Walmart category products
Products listed in a Walmart category with price, rating, review count, image, availability and seller, paged.
Endpoint
/v1/walmart/categorylive · proven3 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
category_id | yes | A Walmart category id | 3944 |
page | no | Page number | 1 |
sort_by | no | best_match, price_low, price_high, best_seller or top_rated | best_match |
min_price | no | Minimum price | |
max_price | no | Maximum price | |
zip_code | no | ZIP code for local availability | |
store_id | no | Store id | |
country | no | us or ca | us |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/walmart/category?category_id=3944" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/walmart/category?category_id=3944",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/walmart/category?category_id=3944",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "walmart",
"endpoint": "/v1/walmart/category",
"data": {
"category_id": "example",
"count": 0,
"cursor": null,
"has_more": false,
"items": [
{
"availability": "example",
"best_seller": false,
"currency": "example",
"description": "example",
"free_shipping": false,
"id": "example",
"image": "https://example.com/example",
"original_price": 0,
"out_of_stock": false,
"platform": "example",
"price": 0,
"rating": {
"max": 0,
"value": 0,
"votes": 0
},
"reviews_count": 0,
"savings": 0,
"seller": "example",
"seller_id": "example",
"sponsored": false,
"title": "example",
"type": "example",
"url": "https://example.com/example"
}
],
"page": 0,
"total_pages": 0
},
"credits_used": 3,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
category_id | string | null | Optional category id supplied by this operation. Null means unknown. |
count | number | null | Number of records in this response, not lifetime or total matches. |
cursor | string | null | Opaque next-page token; pass it back unchanged. Null does not prove complete history. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].availability | string | null | Optional availability supplied by this operation. Null means unknown. |
items[].best_seller | boolean | null | Optional best seller supplied by this operation. Null means unknown. |
items[].currency | string | null | Optional currency supplied by this operation. Null means unknown. |
items[].description | string | null | Source description; null or absent means not supplied. |
items[].free_shipping | boolean | null | Optional free shipping supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].image | string | null | Optional image supplied by this operation. Null means unknown. |
items[].original_price | number | null | Optional original price supplied by this operation. Null means unknown. |
items[].out_of_stock | boolean | null | Optional out of stock supplied by this operation. Null means unknown. |
items[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
items[].price | number | null | Source price. Currency, taxes and availability depend on the listing. |
items[].rating | object | null | Source rating; read its accompanying scale and vote count. |
items[].rating.max | number | null | Optional max supplied by this operation. Null means unknown. |
items[].rating.value | number | null | Optional value supplied by this operation. Null means unknown. |
items[].rating.votes | number | null | Optional votes supplied by this operation. Null means unknown. |
items[].reviews_count | number | null | Optional reviews count supplied by this operation. Null means unknown. |
items[].savings | number | null | Optional savings supplied by this operation. Null means unknown. |
items[].seller | string | null | Optional seller supplied by this operation. Null means unknown. |
items[].seller_id | string | null | Optional seller id supplied by this operation. Null means unknown. |
items[].sponsored | boolean | null | Optional sponsored supplied by this operation. Null means unknown. |
items[].title | string | null | Source title when supplied. |
items[].type | string | null | Optional type supplied by this operation. Null means unknown. |
items[].url | string | null | Original source URL when supplied. |
page | number | null | Optional page supplied by this operation. Null means unknown. |
total_pages | number | null | Optional total pages supplied by this operation. Null means unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference