{
  "openapi": "3.0.1",
  "info": {
    "title": "Walmart Scraper: Products, Prices, UPC & Sellers",
    "description": "Walmart scraper for searches, category URLs and item ids: price, discount, rating, seller and stock, plus UPC, variants, offers and delivery options. Walmart's own sort and filters, an only-changes monitor for price drops and restocks, and no sign-in.",
    "version": "0.1",
    "x-build-id": "viNG40dJs92xdQkVj"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/cleanpull~walmart-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-cleanpull-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/cleanpull~walmart-scraper/runs": {
      "post": {
        "operationId": "runs-sync-cleanpull-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/cleanpull~walmart-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-cleanpull-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": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Words to search on Walmart.com, one per line, for example \"air fryer\" or \"65 inch tv\". Each search gives one row per result, in Walmart's order.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Walmart URLs",
            "type": "array",
            "description": "Optional. Walmart search URLs (https://www.walmart.com/search?q=…), browse or category URLs (https://www.walmart.com/browse/…) and product URLs (https://www.walmart.com/ip/…/123456789). A search or browse URL keeps its own sort and filters; a product URL is read from its product page.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "itemIds": {
            "title": "Item ids",
            "type": "array",
            "description": "Optional. Walmart item ids, the number at the end of a product URL, for example 985675140. Each is read from its product page, with every detail field.",
            "items": {
              "type": "string"
            }
          },
          "maxResultsPerSearch": {
            "title": "Results per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many results to keep from each search or URL, for example 40 (one page). Walmart shows about 40 results a page plus a few ads; the actor follows the pages.",
            "default": 40
          },
          "maxResults": {
            "title": "Max rows",
            "minimum": 1,
            "type": "integer",
            "description": "Optional. Stop after this many rows across the whole run, for example 500."
          },
          "sort": {
            "title": "Sort by",
            "enum": [
              "best_match",
              "price_low",
              "price_high",
              "best_seller",
              "rating_high",
              "new"
            ],
            "type": "string",
            "description": "Walmart's own sort order, sent in its URL. A Walmart URL that already has a sort keeps it.",
            "default": "best_match"
          },
          "minPrice": {
            "title": "Min price (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Optional. Only results at or above this price, for example 50. Sent to Walmart in its URL in every mode, Only changes included, and checked again on each result."
          },
          "maxPrice": {
            "title": "Max price (USD)",
            "minimum": 0,
            "type": "number",
            "description": "Optional. Only results at or below this price, for example 80. Sent to Walmart in its URL in every mode, Only changes included, and checked again on each result."
          },
          "soldByWalmartOnly": {
            "title": "Sold by Walmart only",
            "type": "boolean",
            "description": "Only items Walmart itself sells (not marketplace sellers). Sent to Walmart as its own Retailer filter in every mode, Only changes included, and checked again on each result.",
            "default": false
          },
          "inStockOnly": {
            "title": "In stock only",
            "type": "boolean",
            "description": "Leave out results Walmart marks out of stock. Sent to Walmart as its own \"Show available items only\" filter in every mode, and checked again on each result; left-out results are not charged.",
            "default": false
          },
          "excludeSponsored": {
            "title": "Leave out sponsored results",
            "type": "boolean",
            "description": "Leave out ads. Off: ads are kept and marked sponsored: true. Applied to the results Walmart returns; left-out results are not charged.",
            "default": false
          },
          "includeDetails": {
            "title": "Product details",
            "type": "boolean",
            "description": "Also read each result's product page: UPC, model, variants with their prices and stock, other sellers' offers, delivery and pickup options, clearance and rollback flags, category path, specifications and highlights. Adds $4.00 per 1,000 rows.",
            "default": false
          },
          "onlyChanges": {
            "title": "Only changes",
            "type": "boolean",
            "description": "Return only what changed since the last run with the same monitor name: price drops and rises, back in stock, out of stock, new listings, seller changes and items that left a search. The first run is the baseline (every row). Results that did not change are free; an item id or product URL that did not change costs $4.00 per 1,000 checks (a full product page read).",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "minLength": 1,
            "maxLength": 60,
            "type": "string",
            "description": "Runs with the same name compare against each other, for example \"air-fryers-daily\". Use one name per list you track.",
            "default": "default"
          },
          "changeTypes": {
            "title": "Changes to report",
            "type": "array",
            "description": "Which changes count in Only changes mode, for example only \"price-drop\" and \"back-in-stock\".",
            "items": {
              "type": "string",
              "enum": [
                "price-drop",
                "price-rise",
                "back-in-stock",
                "out-of-stock",
                "new-listing",
                "seller-change",
                "removed",
                "added"
              ],
              "enumTitles": [
                "Price drop",
                "Price rise",
                "Back in stock",
                "Out of stock",
                "New listing in a search",
                "Seller change",
                "Left a search's results",
                "Added (same as new-listing: the changeType new listings' rows show)"
              ]
            },
            "default": [
              "price-drop",
              "price-rise",
              "back-in-stock",
              "out-of-stock",
              "new-listing",
              "seller-change",
              "removed"
            ]
          },
          "minPriceChangePercent": {
            "title": "Smallest price change (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "number",
            "description": "Ignore price moves smaller than this percentage, for example 5. Small moves add up: the price is compared with the last one reported.",
            "default": 0
          },
          "fields": {
            "title": "Only these fields",
            "type": "array",
            "description": "Optional. Keep only these fields in each row, for example [\"id\", \"title\", \"price\", \"upc\", \"pricedFor.postalCode\"]. Dotted paths pick nested fields. recordType is always kept.",
            "items": {
              "type": "string"
            }
          },
          "stateStoreName": {
            "title": "History store",
            "type": "string",
            "description": "Optional. A key-value store in your account where this actor keeps what it saw in earlier runs, so it can report changes. Empty: its own store, \"cleanpull-walmart-monitor\". Pick one here when you run it with a scoped API token in Restricted access mode, so the run may use it. Without access to a history store, a run still completes and compares within itself."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}