API reference
Walmart Product API
One Walmart product: title, brand, price and savings, rating and review counts, seller, category path, description, highlights, specifications and images.
Endpoint
GET/v1/walmart/productlive · proven3 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
id | yes | Walmart item id (the number after /ip/ in its URL), or the URL | 6138924168 |
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/product?id=6138924168" \ -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/product?id=6138924168",
{ 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/product?id=6138924168",
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/product",
"data": {
"availability": "example",
"brand": "example",
"categories": [
"example"
],
"category": "example",
"condition": "example",
"currency": "example",
"description": "example",
"highlights": [
"example"
],
"id": "example",
"image": "https://example.com/example",
"images": [
"example"
],
"model": "example",
"original_price": 0,
"out_of_stock": false,
"platform": "example",
"price": 0,
"rating": {
"max": 0,
"value": 0,
"votes": 0
},
"rating_breakdown": {
"five": 0,
"four": 0,
"one": 0,
"three": 0,
"two": 0
},
"recommended_percentage": 0,
"return_window_days": 0,
"reviews_count": 0,
"savings": 0,
"seller": "example",
"seller_id": "example",
"seller_type": "example",
"specifications": [
{
"name": "example",
"value": "example"
}
],
"title": "example",
"type": "example",
"upc": "example",
"url": "https://example.com/example",
"variants_count": 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 |
|---|---|---|
availability | string | null | Optional availability supplied by this operation. Null means unknown. |
brand | string | null | Optional brand supplied by this operation. Null means unknown. |
categories | array | null | Optional categories supplied by this operation. Null means unknown. |
category | string | null | Optional category supplied by this operation. Null means unknown. |
condition | string | null | Optional condition supplied by this operation. Null means unknown. |
currency | string | null | Optional currency supplied by this operation. Null means unknown. |
description | string | null | Source description; null or absent means not supplied. |
highlights | array | null | Optional highlights supplied by this operation. Null means unknown. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
image | string | null | Optional image supplied by this operation. Null means unknown. |
images | array | null | Optional images supplied by this operation. Null means unknown. |
model | string | null | Optional model supplied by this operation. Null means unknown. |
original_price | number | null | Optional original price supplied by this operation. Null means unknown. |
out_of_stock | boolean | null | Optional out of stock supplied by this operation. Null means unknown. |
platform | string | null | Optional platform supplied by this operation. Null means unknown. |
price | number | null | Source price. Currency, taxes and availability depend on the listing. |
rating | object | null | Source rating; read its accompanying scale and vote count. |
rating.max | number | null | Optional max supplied by this operation. Null means unknown. |
rating.value | number | null | Optional value supplied by this operation. Null means unknown. |
rating.votes | number | null | Optional votes supplied by this operation. Null means unknown. |
rating_breakdown | object | null | Optional rating breakdown supplied by this operation. Null means unknown. |
rating_breakdown.five | number | null | Optional five supplied by this operation. Null means unknown. |
rating_breakdown.four | number | null | Optional four supplied by this operation. Null means unknown. |
rating_breakdown.one | number | null | Optional one supplied by this operation. Null means unknown. |
rating_breakdown.three | number | null | Optional three supplied by this operation. Null means unknown. |
rating_breakdown.two | number | null | Optional two supplied by this operation. Null means unknown. |
recommended_percentage | number | null | Optional recommended percentage supplied by this operation. Null means unknown. |
return_window_days | number | null | Optional return window days supplied by this operation. Null means unknown. |
reviews_count | number | null | Optional reviews count supplied by this operation. Null means unknown. |
savings | number | null | Optional savings supplied by this operation. Null means unknown. |
seller | string | null | Optional seller supplied by this operation. Null means unknown. |
seller_id | string | null | Optional seller id supplied by this operation. Null means unknown. |
seller_type | string | null | Optional seller type supplied by this operation. Null means unknown. |
specifications | array | null | Optional specifications supplied by this operation. Null means unknown. |
specifications[].name | string | null | Optional name supplied by this operation. Null means unknown. |
specifications[].value | string | null | Optional value supplied by this operation. Null means unknown. |
title | string | null | Source title when supplied. |
type | string | null | Optional type supplied by this operation. Null means unknown. |
upc | string | null | Optional upc supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
variants_count | number | null | Optional variants count 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