> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/walmart/search/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/walmart/search/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 1112 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Search Walmart products (https://www.socialfetch.dev/docs/api/v1/walmart/search/get)

## Summary

Search Walmart products by keyword, with prices, ratings, sellers and paging.

**Tags:** `Walmart`

## HTTP

- **Method:** GET
- **Path:** `/v1/walmart/search`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.walmart.search({ query: "air fryer" })`
- **Accepted identifiers:** `query` (query)
- **Pagination:** cursor via `cursor`, next cursor: `data.page.nextCursor`, has more: `data.page.hasMore`
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`

## Credits

- 1 credit
- Failed requests are free
- Found, empty and not-found answers are all charged

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `query` (query)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 200
- **Description:** Words to search for, up to 200 characters (`air fryer`).

### `sort` (query)

- **Required:** no
- **Constraints:** type `string`; enum: relevance, bestselling, top_rated, newest, price_high_to_low, price_low_to_high
- **Description:** Order of the products: `relevance` (default), `bestselling`, `top_rated`, `newest`, `price_high_to_low` or `price_low_to_high`.

### `cursor` (query)

- **Required:** no
- **Constraints:** type `string`; minLength: 1; maxLength: 4096
- **Description:** Pass `page.nextCursor` from the previous response to get the next page. It only works with the same filters.

## Pagination

This endpoint uses **cursor-based pagination** via the `cursor` query parameter.

- Read **hasMore** from `data.page.hasMore`.
- When that value is `true`, read **nextCursor** from `data.page.nextCursor` and pass it as the `cursor` query parameter on the **next** request (URL-encode when building a query string).
- Omit `cursor` on the **first** request.
- Stop when **hasMore** is `false` or **nextCursor** is null (end of list).

## Responses (status codes)

- **200**: Walmart product search results.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Walmart product search results.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found. Always `found`: no match is an empty list.
  - **query** (required) — type `string`. The words searched for.
  - **totalResults** (required) — type `integer`; nullable. Products matching, across every page, as Walmart counts them; null when it does not say.
  - **products** (required) — type `array`. Products on this page, paid placements left out.
    - _items:_
      - **id** (required) — type `string`. Walmart item id, e.g. `16101019327`.
      - **productId** (required) — type `string`; nullable. Walmart's catalogue product id, e.g. `6D1IFLMZTGWY`.
      - **name** (required) — type `string`; nullable. Product name.
      - **brand** (required) — type `string`; nullable. Brand name, when shown.
      - **url** (required) — type `string`; nullable. Product page URL.
      - **imageUrl** (required) — type `string`; nullable. Product image URL.
      - **price** (required) — type `number`; nullable. Price the shopper pays now, in `currency`.
      - **wasPrice** (required) — type `number`; nullable. Earlier price the site shows struck through, when any.
      - **priceText** (required) — type `string`; nullable. Price as the site writes it, e.g. `$44.96`.
      - **unitPriceText** (required) — type `string`; nullable. Price per unit, e.g. `$14.99/qt`, when shown.
      - **currency** (required) — type `string`. Currency code, `USD`.
      - **rating** (required) — type `number`; nullable. Average star rating out of 5; null with no reviews.
      - **reviewCount** (required) — type `integer`; nullable. Number of reviews.
      - **sellerId** (required) — type `string`; nullable. Seller id of the shown offer.
      - **sellerName** (required) — type `string`; nullable. Seller of the shown offer.
      - **availability** (required) — type `string`; nullable. Stock status, e.g. `IN_STOCK` or `OUT_OF_STOCK`.
      - **additionalOfferCount** (required) — type `integer`; nullable. Other sellers' offers for the item, when the site counts them.
      - **isSponsored** (required) — type `boolean`. Whether the card is a paid placement.
      - **badges** (required) — type `array`. Badges on the card: `Rollback`, `Best seller` and more.
        - _items:_
      - **categoryPath** (required) — type `string`; nullable. Category path, e.g. `Home Page/Home/Appliances`.
  - **sponsoredProducts** (required) — type `array`. Paid placements on this page. Walmart repeats them across pages, so they are kept apart from `products`.
    - _items:_
      - **id** (required) — type `string`. Walmart item id, e.g. `16101019327`.
      - **productId** (required) — type `string`; nullable. Walmart's catalogue product id, e.g. `6D1IFLMZTGWY`.
      - **name** (required) — type `string`; nullable. Product name.
      - **brand** (required) — type `string`; nullable. Brand name, when shown.
      - **url** (required) — type `string`; nullable. Product page URL.
      - **imageUrl** (required) — type `string`; nullable. Product image URL.
      - **price** (required) — type `number`; nullable. Price the shopper pays now, in `currency`.
      - **wasPrice** (required) — type `number`; nullable. Earlier price the site shows struck through, when any.
      - **priceText** (required) — type `string`; nullable. Price as the site writes it, e.g. `$44.96`.
      - **unitPriceText** (required) — type `string`; nullable. Price per unit, e.g. `$14.99/qt`, when shown.
      - **currency** (required) — type `string`. Currency code, `USD`.
      - **rating** (required) — type `number`; nullable. Average star rating out of 5; null with no reviews.
      - **reviewCount** (required) — type `integer`; nullable. Number of reviews.
      - **sellerId** (required) — type `string`; nullable. Seller id of the shown offer.
      - **sellerName** (required) — type `string`; nullable. Seller of the shown offer.
      - **availability** (required) — type `string`; nullable. Stock status, e.g. `IN_STOCK` or `OUT_OF_STOCK`.
      - **additionalOfferCount** (required) — type `integer`; nullable. Other sellers' offers for the item, when the site counts them.
      - **isSponsored** (required) — type `boolean`. Whether the card is a paid placement.
      - **badges** (required) — type `array`. Badges on the card: `Rollback`, `Best seller` and more.
        - _items:_
      - **categoryPath** (required) — type `string`; nullable. Category path, e.g. `Home Page/Home/Appliances`.
  - **page** (required) — type `object`. Pagination state for the current page.
    - **hasMore** (required) — type `boolean`. Whether another page is available.
    - **nextCursor** (required) — type `string`; nullable. Cursor to pass in the next request when more pages exist; null on the last page.
    - **truncated** (required) — type `boolean`. True when the list stops here before its end: more rows exist (see `totalResults`) but no further page can be read.
  - **relatedSearches** (required) — type `array`. Related searches the site suggests.
    - _items:_
      - type `string`
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.
  - **stale** (optional) — type `boolean`; enum: true. Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.
  - **fetchedAt** (optional) — type `string`. When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

### Example JSON (OpenAPI example)

```json
{
  "data": {
    "lookupStatus": "found",
    "query": "air fryer",
    "totalResults": 2282,
    "products": [
      {
        "id": "20054074604",
        "productId": "7L6C0DXUVMZR",
        "name": "Ninja Crispi Glass Air Fryer 4-Qt, 3-in-1, Non-Toxic, Air Fry, Recrisp, Portable, Dishwasher Safe, FN090BL Blue",
        "brand": null,
        "url": "https://www.walmart.com/ip/Ninja-Crispi-Glass-Air-Fryer-4-Qt-3-in-1-Air-Fry-Recrisp-Portable-Dishwasher-Safe-FN090BL-Blue/20054074604",
        "imageUrl": "https://i5.walmartimages.com/seo/Ninja-Crispi-Glass-Air-Fryer-4-Qt-3-in-1-Air-Fry-Recrisp-Portable-Dishwasher-Safe-FN090BL-Blue_e03e1c66-c586-48d0-8252-21def8aa522c.c9c503ad47d447d62d115a010601b00a.jpeg",
        "price": 89,
        "wasPrice": 139,
        "priceText": "$89.00",
        "unitPriceText": null,
        "currency": "USD",
        "rating": 4.6,
        "reviewCount": 1805,
        "sellerId": "F55CDC31AB754BB68FE0B39041159D63",
        "sellerName": "Walmart.com",
        "availability": "IN_STOCK",
        "additionalOfferCount": null,
        "isSponsored": false,
        "badges": [],
        "categoryPath": "Home Page/Home/Appliances/Kitchen Appliances/Fryers/Air Fryers/Ninja Air Fryers"
      }
    ],
    "sponsoredProducts": [
      {
        "id": "20223605761",
        "productId": "53YBSFL18Y05",
        "name": "DAIVOS 5QT Air Fryer with Viewing Window, 12 Cooking Presets, 1500W Fast , Even Cooking",
        "brand": null,
        "url": "https://www.walmart.com/ip/DAIVOS-5QT-Air-Fryer-with-Viewing-Window-12-Cooking-Presets-1500W-Fast-Even-Cooking/20223605761",
        "imageUrl": "https://i5.walmartimages.com/seo/DAIVOS-5QT-Air-Fryer-with-Viewing-Window-12-Cooking-Presets-1500W-Fast-Even-Cooking_d6a0a410-43d0-4929-a9c0-08399d1d49b2.9bd9230739d0bddcde152adcb23bdaf4.jpeg",
        "price": 59.39,
        "wasPrice": 99.99,
        "priceText": "$59.39",
        "unitPriceText": null,
        "currency": "USD",
        "rating": 4.7,
        "reviewCount": 110,
        "sellerId": "A95C00F4C0C948E08B5C7601F95B6458",
        "sellerName": "Hongti Technology",
        "availability": "IN_STOCK",
        "additionalOfferCount": null,
        "isSponsored": true,
        "badges": [],
        "categoryPath": "Home Page/Home/Appliances/Kitchen Appliances/Shop Kitchen Appliances"
      }
    ],
    "page": {
      "hasMore": true,
      "nextCursor": "eyJ2IjoxLCJrIjoic2VhcmNoIiwicCI6MiwiZiI6IjFsM3NjZyIsIm4iOjQwLCJ0IjoyMjgyfQ",
      "truncated": false
    },
    "relatedSearches": [
      "air fryer food"
    ]
  },
  "meta": {
    "requestId": "req_01example_walmart_search",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.walmart.search({
  query: "air fryer",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/walmart/search?query=air%20fryer",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/walmart/search?query=air%20fryer" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/walmart/search?query=air%20fryer",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```

### Example: next page (pagination)

After a successful response, if pagination is not finished, request the next page using `cursor` (URL-encode when composing the query string):

```javascript
const previous = await response.json();
const nextCursor = previous?.data?.page?.nextCursor;
const hasMore = previous?.data?.page?.hasMore;
if (!hasMore || nextCursor == null) {
  // no more pages
} else {
  const nextUrl = new URL("https://api.socialfetch.dev/v1/walmart/search");
  nextUrl.searchParams.set("cursor", nextCursor);
  // optionally preserve sort: nextUrl.searchParams.set("sortBy", "latest");
  const nextResponse = await fetch(nextUrl.toString(), {
    headers: { "x-api-key": "YOUR_API_KEY" },
  });
  const nextData = await nextResponse.json();
}
```