What you get#
Onekey exposes Walmart as 5 endpoints behind one API key: 1 endpoint return one record (data is an object) and 4 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Walmart also works for the rest of the e-commerce & marketplaces category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
category | Browse Walmart products in a category. | category_id*, cursor | 2 | beta needs a pack |
offers | Every seller offering a Walmart product. | product_id, url | 2 | beta needs a pack |
product | Walmart product page metadata by item id. | item_id* | 3 | beta needs a pack |
reviews | Walmart product reviews. | product_id, url, cursor | 2 | beta needs a pack |
search | Walmart search results page (links only). | q* | 3 | beta needs a pack |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls walmart.product (3 credits, beta). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/walmart/product?item_id=5253396" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Walmart, with the same names as on every other platform. The count is how many of its 5 mapped endpoints return the field; a field the source lacks is null, never missing. 2 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
entity.url | URL | 4 |
entity.name | string | 3 |
entity.description | string | 2 |
entity.id | string | 2 |
listing.currency | string | 2 |
listing.price | number | 2 |
media.thumbnailUrl | URL | 2 |
author.displayName | string | 1 |
content.createdAt | ISO 8601 date | 1 |
content.id | string | 1 |
content.text | string | 1 |
content.title | string | 1 |
engagement.votes | integer | 1 |
entity.stats.rating | number | 1 |
entity.stats.ratingCount | integer | 1 |
listing.available | boolean | 1 |
listing.brand | string | 1 |
listing.condition | string | 1 |
listing.seller | string | 1 |
The full schema is in Unified schema.
Pricing#
Walmart calls cost 2 to 3 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.