{ "openapi": "3.0.1", "info": { "title": "OBI.de Scraper - Prices, Offers & Reviews", "description": "Scrape OBI (obi.de) DIY/home-improvement products: current + strike-through original price with discount, per-unit pricing (per m2/kg), specials/offers listings, brand, EAN, multi-seller stock, tech specs, and full reviews with rating breakdown. Search or paste links.", "version": "1.0", "x-build-id": "HGtvaieyVUzy1Hh8U" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~obi-de-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-obi-de-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/abotapi~obi-de-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-obi-de-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/abotapi~obi-de-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-obi-de-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "url" ], "type": "string", "description": "'search' finds products by keyword, category, and/or the site's own currently-discounted specials, with real site filters. 'url' scrapes any product, search-result, or category page URL you paste, walking pagination forward automatically.", "default": "search" }, "searchTerm": { "title": "Search keyword or category slug", "type": "string", "description": "Free-text keyword (e.g. 'akku ventilator') or a known OBI category slug (e.g. 'werkzeuge', 'garten', 'bad', 'kueche') to browse a whole listing. Leave empty and set only Specials category below to browse current offers." }, "urls": { "title": "URLs to scrape", "uniqueItems": true, "type": "array", "description": "Paste OBI product pages (.../p/[/]), search/category/specials listing pages (.../search//, with or without trailing slash, with or without ?page=), or brand shop pages (.../marken/, mapped to the brand listing). Pagination continues forward from any ?page= already in the URL. The site ignores ?sort=: the actor warns and orders within each fetched page only. The default list holds one example per distinct target; the prefill additionally shows the redirect and sort variants, which resolve to the same targets.", "default": [ "https://www.obi.de/search/akku%20ventilator/", "https://www.obi.de/search/werkzeuge/?page=3", "https://www.obi.de/search/werkzeuge/", "https://www.obi.de/search/aktion/", "https://www.obi.de/p/6929863/einhell-werkzeugkoffer-universal-80tlg-e-case", "https://www.obi.de/marken/eufy" ], "items": { "type": "string" } }, "specialsOnly": { "title": "Specials / offers only", "type": "boolean", "description": "OBI has no separate 'on sale' category route -- it marks currently-reduced products with a strike-through original price inline in every listing. Turn this on to keep only products that currently show a reduced price and discount (narrows the same search/category listing, verified live on 'aktion').", "default": false }, "brands": { "title": "Brands", "uniqueItems": true, "type": "array", "description": "Only return products from these brands, e.g. 'Bosch', 'Einhell', 'Makita'. Match the exact brand name as shown on the site. Leave empty for all brands.", "items": { "type": "string" } }, "minRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only return products rated at or above this many stars, 1-5." }, "minPrice": { "title": "Minimum price (EUR)", "type": "number", "description": "Only return products priced at or above this amount, in euros." }, "maxPrice": { "title": "Maximum price (EUR)", "type": "number", "description": "Only return products priced at or below this amount, in euros." }, "sortBy": { "title": "Sort order", "enum": [ "RELEVANCE", "PRICE_ASC", "PRICE_DESC", "RATING" ], "type": "string", "description": "Order of the returned results (applied to the fetched result set; for a fully sorted view across a large catalog, combine with a larger Max products total).", "default": "RELEVANCE" }, "fetchDetails": { "title": "Fetch full product detail", "type": "boolean", "description": "Adds the full breadcrumb category path, description, technical data/specifications (flattened), media gallery, variants, EAN, multi-seller pricing/stock, and manufacturer info from the product detail page. Current price, was-price/discount, unit price and rating are already included without this toggle.", "default": false }, "fetchReviews": { "title": "Fetch reviews", "type": "boolean", "description": "Fetch each product's full review history: overall rating, review count, a full 1-5 rating breakdown, and per-review author/date/rating/title/body. Products with no reviews simply return an empty list. The detail-enrichment charge is one unit per started block of 10 reviews returned, with the product read folded into the first block (minimum 1 unit per enriched row; see the Pricing tab).", "default": true }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Cap on reviews fetched per product when 'Fetch reviews' is on. 0 = all available reviews, up to 5000 per product.", "default": 20 }, "maxPages": { "title": "Max pages per search", "minimum": 0, "type": "integer", "description": "Stop after this many result pages per search/category/URL entry. Leave empty for the built-in hard limit of 1000 pages per entry; the run also stops at Max products total." }, "maxItems": { "title": "Max products total", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Hard cap on total products returned across every search/category/URL entry. 0 = the maximum of 100000 (still bounded by Max pages per search).", "default": 20 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "The default connection works on every Apify plan, including the free tier. A residential connection is optional and only needed for very large or sustained runs.", "default": { "useApifyProxy": true } }, "resumeFromRunId": { "title": "Resume from a previous run", "type": "string", "description": "Paste a previous run ID or dataset ID to continue a large crawl of products without returning or charging for products already collected there. Use this after an interrupted run, or when continuing a product catalogue pull in another run. For recurring daily monitoring of the same search, use Incremental mode below instead." }, "incrementalMode": { "title": "Incremental changes for scheduled runs", "type": "boolean", "description": "Turn this on for daily or recurring monitoring. The first run returns all matching products as NEW. Later runs normally return only NEW, UPDATED, and REAPPEARED products. UPDATED means a compared field changed: price, original price, discount, special flag, availability, rating, review count, name, brand, category, images, detail fields and so on. Reviews (the nested reviews block) and the scrapedAt timestamp are never compared, so a new review never creates a billable row; they stay in every returned row. Use \"Ignore fields when detecting changes\" and \"Change scope\" below to narrow what counts. Turn on \"Emit unchanged\" or \"Emit expired\" only when you also want those products returned (and billed). State is kept separately for each search term/URL and mode/filter/detail setup; use State key when you want to name or deliberately share a monitoring campaign. To continue one specific interrupted run instead, use Resume from a previous run above.", "default": false }, "stateKey": { "title": "State key (optional, incremental mode only)", "type": "string", "description": "Optional. Name this monitoring campaign to keep its state stable, or to deliberately share state across differently-configured runs. Leave empty to let the actor derive a key automatically from the search term/URLs and filter settings -- different searches then never mix state with each other." }, "emitUnchanged": { "title": "Emit unchanged products (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return products that have not changed since the last run, marked UNCHANGED. This returns -- and bills -- extra rows you already have, so leave it off unless you specifically want the full snapshot every run.", "default": false }, "emitExpired": { "title": "Emit expired products (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return products that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned the tracked search -- not when Max products capped it or when Resume was used. This returns -- and bills -- extra synthetic rows, so leave it off unless you need expiry tracking. EXPIRED means the product was not found on a complete scan; it does not prove the product was delisted.", "default": false }, "changeScope": { "title": "Change scope (incremental mode only)", "enum": [ "all", "priceAndStock" ], "type": "string", "description": "All (default): any compared field that changes makes a product UPDATED. Price and stock only: only price, original price, discount, special flag and availability decide UPDATED; name, images, category and other metadata never create a row. Changing this with the automatic state key starts a fresh baseline (everything NEW once); set a State key to keep the current baseline.", "default": "all" }, "compactUpdates": { "title": "Compact UPDATED rows (incremental mode only)", "type": "boolean", "description": "Off by default. When on, UPDATED and EXPIRED rows are slim: ids, url, name, current price and availability plus priceChanges (old and new value per moved field). NEW rows stay full. A compact row carries no reviews or detail fields, so no detail-enrichment charge is made for it.", "default": false }, "expireAfterMissedScans": { "title": "Expire after N missed scans (incremental mode only)", "minimum": 1, "type": "integer", "description": "With Emit expired on, a product is marked EXPIRED only after it was missing from this many consecutive complete scans (default 1). EXPIRED means the product dropped out of the listing; it does not prove it was delisted or is out of stock.", "default": 1 }, "ignoreFieldsForChanges": { "title": "Ignore fields when detecting changes (incremental mode only)", "type": "array", "description": "Field names that never decide UPDATED (they stay in every returned row). A dotted path such as images.url or reviews.items drops that key inside nested values. Reviews and scrapedAt are always ignored. Example: rating, reviewCount.", "items": { "type": "string" } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify -> Settings -> Integrations, then select it here. The connector receives a condensed, human-readable summary per item (title + key fields), not the full JSON; the complete record stays in the dataset. Leave empty to skip. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)." }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL (or id) of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on items written to each connector per run. Does not affect the dataset.", "default": 50 } } }, "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 } } } } } } } } } }