{
  "openapi": "3.0.1",
  "info": {
    "title": "Leroy Merlin France Products Scraper",
    "description": "Scrape leroymerlin.fr products by keyword, category or URL: price incl. and excl. VAT, discount, seller, offers, rating, EAN, specs, reviews and stock in nearby stores. Export to JSON, CSV or Excel.",
    "version": "0.0",
    "x-build-id": "pOG72oAgqgdtWNVfM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nice_dev~leroymerlin-products-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nice_dev-leroymerlin-products-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/nice_dev~leroymerlin-products-scraper/runs": {
      "post": {
        "operationId": "runs-sync-nice_dev-leroymerlin-products-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/nice_dev~leroymerlin-products-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-nice_dev-leroymerlin-products-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": {
          "startUrls": {
            "title": "Start URLs",
            "maxItems": 1000,
            "type": "array",
            "description": "leroymerlin.fr search URLs (`https://www.leroymerlin.fr/search?q=…`), category URLs (`https://www.leroymerlin.fr/produits/outillage/outillage-electroportatif/perceuse/`, filters and sort set on the site are kept, pagination is automatic) or product URLs (`https://www.leroymerlin.fr/produits/perceuse-a-percussion-filaire-dexter-dp5-900-w-82550081.html`). When this list is not empty, the keyword and category fields below are ignored; filters, caps and monitoring still apply. Max 1 000 URLs.",
            "default": [],
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "query": {
            "title": "Search keyword",
            "maxLength": 200,
            "type": "string",
            "description": "Free-text search, exactly as typed in the leroymerlin.fr search box (e.g. `perceuse`, `meuleuse sans fil`). A keyword that matches a whole category (e.g. `perceuse`) returns that category, as on the site."
          },
          "searchQueries": {
            "title": "More search keywords",
            "maxItems": 100,
            "uniqueItems": true,
            "type": "array",
            "description": "Several keywords in one run: one search per keyword. Added to **Search keyword**; products found by several searches are saved once.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "categoryPaths": {
            "title": "Categories",
            "maxItems": 100,
            "uniqueItems": true,
            "type": "array",
            "description": "Whole categories: the path after `/produits/` in a leroymerlin.fr category URL (`outillage/outillage-electroportatif/perceuse`) or the full URL. Leroy Merlin shows at most 2 000 products per list: for a bigger category, add its sub-categories or a brand / price filter.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max products",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum number of products to save for the whole run (after deduplication and filters). 0 = no limit.",
            "default": 100
          },
          "maxItemsPerQuery": {
            "title": "Max products per search",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Cap for EACH search (keyword, category or URL), so that the first search cannot use up the whole **Max products** budget. 0 = no per-search cap.",
            "default": 0
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "priceLowToHigh",
              "priceHighToLow"
            ],
            "type": "string",
            "description": "Order of the results, as on the site. Combined with the caps above it decides WHICH products you get (e.g. the 100 cheapest).",
            "default": "relevance"
          },
          "extractDetails": {
            "title": "Extract product details",
            "type": "boolean",
            "description": "Open each product page (1 extra request per product) for the EAN / GTIN, full description, specifications table, breadcrumb, all photos, warranty, delivery options with stock and delay, and every marketplace offer (seller, price). Charged per product delivered with its page (see Pricing). Off = the fields of the results page only.",
            "default": false
          },
          "includeReviews": {
            "title": "Include customer reviews",
            "type": "boolean",
            "description": "Add the customer reviews of each product: rating, text, date, how long the product was used, recommended or not, helpful votes, photos, original site (reviews from Leroy Merlin Spain, Italy or Portugal come translated into French). About 8 reviews per extra request. Charged per review delivered (see Pricing).",
            "default": false
          },
          "maxReviewsPerProduct": {
            "title": "Max reviews per product",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Reviews to add per product. 0 = all of them.",
            "default": 20
          },
          "reviewsSort": {
            "title": "Reviews order",
            "enum": [
              "newest",
              "lowestRating"
            ],
            "type": "string",
            "description": "Which reviews come first (and therefore which ones you get under the cap above).",
            "default": "newest"
          },
          "reviewsFrenchOnly": {
            "title": "French reviews only",
            "type": "boolean",
            "description": "Keep only the reviews written on leroymerlin.fr (off = also the reviews of the same product on the Spanish, Italian and Portuguese sites, translated by Leroy Merlin).",
            "default": false
          },
          "reviewsPostedAfter": {
            "title": "Reviews posted after",
            "type": "string",
            "description": "Only reviews published on or after this date: `2026-09-01`, or a period before now such as `7 days`, `1 month`."
          },
          "includeStoreStock": {
            "title": "Include stock in nearby stores",
            "type": "boolean",
            "description": "For each product, add the stock of up to 10 Leroy Merlin stores closest to each place below (store id, name, city, address, units in stock). 1 extra light request per product and place. Charged per product and place (see Pricing).",
            "default": false
          },
          "storeLocation": {
            "title": "Store area",
            "maxLength": 100,
            "type": "string",
            "description": "City or postcode around which the store stock is read (e.g. `Lyon`, `33000`). Used only with **Include stock in nearby stores**."
          },
          "storeLocations": {
            "title": "More store areas",
            "maxItems": 20,
            "uniqueItems": true,
            "type": "array",
            "description": "Several cities or postcodes: each product gets the stock of the stores around each of them (a store near two places is listed once). Added to **Store area**. Max 20.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Min price (€)",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Only products priced at or above this amount, VAT included."
          },
          "maxPrice": {
            "title": "Max price (€)",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Only products priced at or below this amount, VAT included."
          },
          "minRating": {
            "title": "Min rating",
            "enum": [
              "",
              "3",
              "4"
            ],
            "type": "string",
            "description": "Only products rated at least this many stars.",
            "default": ""
          },
          "filterBrands": {
            "title": "Brands",
            "maxItems": 50,
            "uniqueItems": true,
            "type": "array",
            "description": "Keep only these brands, as written on leroymerlin.fr (e.g. `MAKITA`, `DEWALT`, `DEXTER`; case ignored).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "sellerFilter": {
            "title": "Seller",
            "enum": [
              "all",
              "leroyMerlin",
              "marketplace"
            ],
            "type": "string",
            "description": "Products sold by Leroy Merlin itself, by marketplace sellers only, or both.",
            "default": "all"
          },
          "onPromotionOnly": {
            "title": "Discounted products only",
            "type": "boolean",
            "description": "Only products shown with a crossed-out price or a discount of at least 1%.",
            "default": false
          },
          "excludeSponsored": {
            "title": "Exclude sponsored products",
            "type": "boolean",
            "description": "Drop the sponsored products that Leroy Merlin inserts in the results.",
            "default": false
          },
          "excludeKeywords": {
            "title": "Exclude keywords",
            "maxItems": 50,
            "uniqueItems": true,
            "type": "array",
            "description": "Drop the products whose name or brand contains one of these words (case and accents ignored).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "onlyNew": {
            "title": "Only new products",
            "type": "boolean",
            "description": "Skip the products that a previous run (same **Memory key**) already delivered: they are not saved and not charged, and their page is not even opened. First run = everything is new.",
            "default": false
          },
          "stateKey": {
            "title": "Memory key",
            "pattern": "^[a-zA-Z0-9_-]{1,64}$",
            "maxLength": 64,
            "type": "string",
            "description": "Name of the memory used by **Only new products**. Give each schedule / task its own key (e.g. `new-drills`) so that they do not share their memory. Letters, digits, `-` and `_`.",
            "default": "default"
          },
          "resetState": {
            "title": "Reset the memory",
            "type": "boolean",
            "description": "Forget everything remembered under this **Memory key** before the run: this run returns (and charges) every product again. Untick it afterwards.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify Proxy or your own proxies. Keep the default: it is included in the price. The residential Apify proxy is not available in this Actor.",
            "default": {
              "useApifyProxy": true
            }
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Maximum number of requests processed in parallel.",
            "default": 8
          },
          "maxRequestsPerMinute": {
            "title": "Max requests per minute",
            "minimum": 10,
            "maximum": 2000,
            "type": "integer",
            "description": "Most requests to the site in any 60 seconds, all of them counted: results pages, product pages, reviews and store stock. A budget, not an even pace: up to this many can leave at once when the minute starts (spread them with the minimum delay below). Lower it if the site answers HTTP 429 / 403 in the log.",
            "default": 120
          },
          "minRequestIntervalMs": {
            "title": "Min delay between requests",
            "minimum": 0,
            "maximum": 60000,
            "type": "integer",
            "description": "Smallest gap between two requests, in milliseconds. Unlike the per-minute rate, this spreads the requests evenly instead of letting them go out in a burst. 0 = no gap.",
            "default": 0
          },
          "maxRequestRetries": {
            "title": "Max request retries",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Retries per request before it is marked as failed. Behind a proxy, a request the site turns away is also retried on a new proxy session up to 10 times without using up these retries.",
            "default": 5
          },
          "debugLog": {
            "title": "Debug log",
            "type": "boolean",
            "description": "Include debug messages in the run log.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}