{
  "openapi": "3.0.1",
  "info": {
    "title": "Walmart Scraper - Products, Prices, Reviews & Sellers",
    "description": "Scrape Walmart.com products by keyword, category or link: price, was-price, unit price, rating, stock, pickup/delivery, seller, badges, variants, UPC. Add-ons: full details, customer reviews, seller contacts. No login. $0.63 per 1,000 products.",
    "version": "0.1",
    "x-build-id": "NFszIVdfZQJA3dPUy"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~walmart-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-walmart-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/topapi~walmart-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-walmart-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/topapi~walmart-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-walmart-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "searchQueries": {
            "title": "🔍 Search keywords",
            "type": "array",
            "description": "Words to search on Walmart.com, one per line, exactly as you would type them in Walmart's search box. Each keyword is paged through Walmart's results (40-60 products a page) up to the limits below.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 Walmart links or product IDs",
            "type": "array",
            "description": "Walmart.com links, one per line: product pages (https://www.walmart.com/ip/...), search pages (/search?q=...), category and department pages (/browse/..., /cp/...), deals pages (/shop/...), a seller's whole shelf (/seller/<id>/cp/shopall, read like a search), seller profile pages (/seller/<id>) or reviews pages (/reviews/product/<id>). A bare product number (usItemId, e.g. 835951198) also works. Product links come back with full details.",
            "items": {
              "type": "string"
            }
          },
          "categoryIds": {
            "title": "🗂️ Category IDs",
            "type": "array",
            "description": "Walmart category ids (the last part of a /browse/ link, e.g. 5440_202072_8052432 for Dog Treats). Each one is read like a search.",
            "items": {
              "type": "string"
            }
          },
          "sellerIds": {
            "title": "🏪 Seller IDs",
            "type": "array",
            "description": "Walmart Marketplace seller ids (the number in https://www.walmart.com/seller/101113549) or seller links. Each one comes back as a seller profile row (charged as a seller profile).",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max products",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many product rows in total. Reviews and seller profiles are capped by their own settings.",
            "default": 100
          },
          "maxItemsPerSearch": {
            "title": "Max products per keyword or link",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop each keyword, category or listing link after this many products. In monitor mode this is the window checked each run: the first N results of the search, of which only the new (or changed) ones are returned.",
            "default": 100
          },
          "maxPagesPerSearch": {
            "title": "Max pages per keyword or link",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Walmart shows 40-60 products a page and at most 25 pages for one search.",
            "default": 25
          },
          "sort": {
            "title": "Sort by",
            "enum": [
              "best_match",
              "price_low",
              "price_high",
              "best_seller",
              "rating_high",
              "new"
            ],
            "type": "string",
            "description": "Walmart's own sort order for keyword and category searches.",
            "default": "best_match"
          },
          "minPrice": {
            "title": "Min price (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Keep only products at or above this price."
          },
          "maxPrice": {
            "title": "Max price (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Keep only products at or below this price."
          },
          "facets": {
            "title": "Walmart facet filter",
            "type": "string",
            "description": "Walmart's own facet filter, as it appears after facet= in a filtered Walmart search link, e.g. brand:Gildan or retailer_type:Walmart. Several are joined with ||, e.g. brand:Gildan||customer_rating:4 - 5 Stars."
          },
          "inStockOnly": {
            "title": "In stock only",
            "type": "boolean",
            "description": "Skip products Walmart shows as out of stock (not charged).",
            "default": false
          },
          "onSaleOnly": {
            "title": "On sale only",
            "type": "boolean",
            "description": "Keep only products with a was-price, Rollback, Clearance or Reduced price badge.",
            "default": false
          },
          "soldByWalmartOnly": {
            "title": "Sold by Walmart only",
            "type": "boolean",
            "description": "Skip products sold by Marketplace sellers.",
            "default": false
          },
          "excludeSponsored": {
            "title": "Skip sponsored products",
            "type": "boolean",
            "description": "Skip the sponsored (ad) tiles Walmart mixes into the results.",
            "default": false
          },
          "minRating": {
            "title": "Min star rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Keep only products rated at least this (1-5)."
          },
          "minReviews": {
            "title": "Min number of reviews",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only products with at least this many ratings."
          },
          "brands": {
            "title": "Brands",
            "type": "array",
            "description": "Keep only these brands (case-insensitive). On search rows Walmart often omits the brand; then the product name must start with it. For an exact brand filter at Walmart's side use the facet brand:<name>.",
            "items": {
              "type": "string"
            }
          },
          "includeDetails": {
            "title": "Full product details",
            "type": "boolean",
            "description": "Open every product page and return the full record: UPC, model, description, specifications, highlights, all images, videos, every variant with its price and stock, the 1-5 star breakdown, seller rating and catalog seller id, return policy and every fulfillment option. Charged as a product plus a product-details add-on. Product links always come with details.",
            "default": false
          },
          "enqueueProductVariants": {
            "title": "Every variant as its own row",
            "type": "boolean",
            "description": "With details: also return each size / color / pack variant of a product as its own full product row (each charged as a product with details). Without it, the variants come in the product's variantList at no extra charge.",
            "default": false
          },
          "includeReviews": {
            "title": "Customer reviews",
            "type": "boolean",
            "description": "Return the customer reviews of every product found, as review rows (charged per review).",
            "default": false
          },
          "maxReviewsPerProduct": {
            "title": "Max reviews per product",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Walmart shows 10 reviews a page.",
            "default": 20
          },
          "reviewsSort": {
            "title": "Review order",
            "enum": [
              "relevancy",
              "helpful",
              "submission-desc",
              "submission-asc",
              "rating-desc",
              "rating-asc"
            ],
            "type": "string",
            "description": "Walmart's own review order.",
            "default": "relevancy"
          },
          "reviewRating": {
            "title": "Only reviews with this star rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "1-5. Walmart filters the reviews by stars before they are read."
          },
          "verifiedPurchasesOnly": {
            "title": "Verified purchases only",
            "type": "boolean",
            "description": "Keep only reviews with Walmart's Verified Purchase badge (others are skipped, not charged).",
            "default": false
          },
          "reviewsSince": {
            "title": "Reviews since (date)",
            "type": "string",
            "description": "Keep only reviews written on or after this date (YYYY-MM-DD). The reviews are then read newest first and reading stops at the first older one."
          },
          "includeSellerDetails": {
            "title": "Seller profiles",
            "type": "boolean",
            "description": "With details: return the profile of every Marketplace seller found (once per seller): display name, rating, review count, email, phone, business address and about text, as Walmart shows them. Charged per seller profile.",
            "default": false
          },
          "monitorMode": {
            "title": "Only new products since the last run",
            "type": "boolean",
            "description": "Remember what earlier runs delivered (in a named key-value store) and return only products, reviews and sellers not delivered before. Ideal for a scheduled run.",
            "default": false
          },
          "monitorChanges": {
            "title": "Also return price and stock changes",
            "type": "boolean",
            "description": "In monitor mode: also return products delivered before whose price or availability changed since, with previousPrice and previousAvailability.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor memory name",
            "type": "string",
            "description": "Name of the key-value store that remembers delivered records. Use a different name per schedule.",
            "default": "walmart-monitor"
          },
          "resetMonitor": {
            "title": "Forget earlier runs",
            "type": "boolean",
            "description": "Start the monitor memory fresh for this run.",
            "default": false
          },
          "proxyMode": {
            "title": "Product, review and seller pages when Walmart's bot check blocks the free routes",
            "enum": [
              "auto",
              "unblocker"
            ],
            "type": "string",
            "description": "Walmart's bot check usually stops product pages after a few to a few dozen on the free routes. By default the rest are left unread, never charged, and listed for a retry (PRODUCT_STATUS, retryStartUrls). \"unblocker\" keeps reading them on Apify's residential proxy and, if Walmart refuses that too, Apify's Unblocker (slower: 3-18 s a page). Same prices. A run reads pages on these routes while the rows it has delivered cover their cost; a page it has no room for is left unread, never charged, and listed for a retry. Search, category and shelf pages use every route in both settings.",
            "default": "auto"
          },
          "writeRunSummary": {
            "title": "Always write the run report (RUN_SUMMARY)",
            "type": "boolean",
            "description": "Write the key-value record RUN_SUMMARY on every run: one entry per keyword, category or shelf link (Walmart's count, pages read, products delivered, why it stopped, paginationComplete, alsoListedItemIds) plus the run's totals. Left unset, it is written for runs of 50+ rows and for runs with something to report (refusals, unread pages, limits, a product on several listings)."
          },
          "requestDelaySecs": {
            "title": "Pause between page requests (seconds)",
            "minimum": 1,
            "maximum": 30,
            "type": "number",
            "description": "The actor reads one Walmart page at a time with this pause between pages, which keeps Walmart's bot check from refusing the run. Lower is faster but may be refused sooner.",
            "default": 2.5
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}