{ "openapi": "3.0.1", "info": { "title": "Allegro Scraper - Products, Prices and Sellers", "description": "Extract Allegro offers, prices, sellers and product details from Poland, Czechia, Slovakia and Hungary. Search keywords, categories or barcodes and pay per delivered row plus a start fee.", "version": "0.1", "x-build-id": "bPRi7tRdSme948tXb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~allegro-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-allegro-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/lentic_clockss~allegro-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-allegro-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/lentic_clockss~allegro-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-allegro-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": { "mode": { "title": "Mode", "enum": [ "auto", "search", "category", "categories", "department", "deals", "product", "product_offers", "offer", "seller", "lokalnie", "lokalnie_crawl", "allegro_api", "ean", "image_search", "wakacje" ], "type": "string", "description": "Choose Auto to select a mode from your target fields, or choose a specific mode below. Some modes depend on feature availability.", "default": "auto" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Enter Allegro page URLs as strings or objects with a url field. The URL determines the market.", "items": { "type": "string" } }, "query": { "title": "Search query", "type": "string", "description": "Enter one keyword for search, Lokalnie, Allegro API search or Wakacje. With Auto selected, this field starts a keyword search." }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional list of keywords. Each keyword is collected separately, up to maxResults rows for each keyword; every row is charged.", "items": { "type": "string" } }, "categoryId": { "title": "Category ID", "type": "string", "description": "Enter the numeric category ID from an Allegro category URL." }, "categoryIds": { "title": "Category IDs", "type": "array", "description": "Optional list of category IDs. Each category is collected separately, up to maxResults rows for each category; every row is charged.", "items": { "type": "string" } }, "productId": { "title": "Product UUID", "type": "string", "description": "Enter the catalog product UUID from an Allegro product URL." }, "offerId": { "title": "Offer ID", "type": "string", "description": "Enter the numeric identifier of a single-seller offer." }, "sellerLogin": { "title": "Seller login", "type": "string", "description": "Enter the seller login used in the storefront URL." }, "eans": { "title": "EANs / GTINs", "type": "array", "description": "Enter 8–14 digit EAN or GTIN barcodes for EAN lookup. Results may include near matches; keywords belong in search mode.", "items": { "type": "string" } }, "ean": { "title": "EAN", "type": "string", "description": "Enter one EAN barcode instead of the eans list." }, "imageUrl": { "title": "Image URL", "pattern": "^https?://", "type": "string", "description": "Enter a publicly accessible HTTP or HTTPS image URL for image search. The run can fail if image upload is unavailable." }, "departmentCode": { "title": "Department code", "type": "string", "description": "Enter a department code, such as elektronika or moda, for department mode." }, "city": { "title": "City / geo", "type": "string", "description": "Enter a city for Lokalnie, such as warszawa." }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum rows for each keyword, URL, category, barcode or other target, from 1 to 500; default 70. All row types share the limit, with the whole run constrained by your maximum charge and Free plan limits of 200 rows per run and 10 runs.", "default": 70 }, "country": { "title": "Country", "enum": [ "pl", "cz", "sk", "hu" ], "type": "string", "description": "Choose the main Allegro market: Poland, Czechia, Slovakia or Hungary.", "default": "pl" }, "domain": { "title": "Domain", "enum": [ "allegro.pl", "allegro.cz", "allegro.sk", "allegro.hu", "allegrolokalnie.pl", "wakacje.allegro.pl" ], "type": "string", "description": "Choose the matching Allegro domain. A supplied page URL takes priority; Lokalnie and Wakacje use their Polish domains.", "default": "allegro.pl" }, "categorySlug": { "title": "Category slug", "type": "string", "description": "Enter the text part of the category URL when known, for category or seller-category listings." }, "order": { "title": "Sort order", "enum": [ "m", "p", "pd", "d", "n", "qd" ], "type": "string", "description": "Choose relevance, price ascending, price descending, price with delivery, newest or popularity. Availability varies by page.", "default": "m" }, "p": { "title": "Category page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Enter the starting category page number, from 1 to 500.", "default": 1 }, "enrichDetails": { "title": "Enrich details", "type": "boolean", "description": "Add available brand, barcode, attributes, images and other offer details. This is optional and may take longer; in Lokalnie discovery it can also add separately billed related offers within the row limit.", "default": false }, "scrapeProductDetails": { "title": "Scrape product details", "type": "boolean", "description": "Alternative switch for enrichDetails. Enabling either switch requests available product details.", "default": false }, "priceFrom": { "title": "Price from", "type": "number", "description": "Minimum offer price in the selected market currency, where the page supports this filter." }, "priceTo": { "title": "Price to", "type": "number", "description": "Maximum offer price in the selected market currency, where the page supports this filter." }, "condition": { "title": "Condition", "type": "string", "description": "Enter the site condition value, such as new or used, where supported." }, "buyNow": { "title": "Buy now only", "type": "boolean", "description": "Request buy-now offers only, where supported." }, "freeShipping": { "title": "Free shipping", "type": "boolean", "description": "Request offers with free shipping, where supported." }, "offerType": { "title": "Offer type", "type": "string", "description": "Enter the offer-type filter used by the selected page." }, "seller": { "title": "Seller filter", "type": "string", "description": "Enter a seller login to filter listing results, where supported." }, "experimentalFilters": { "title": "Additional test options", "type": "object", "description": "Leave empty. Used only by the developer for testing." }, "shippingCountry": { "title": "Shipping test setting", "type": "string", "description": "Leave empty. Used only by the developer for testing." }, "workerBaseUrl": { "title": "Developer test setting", "type": "string", "description": "Leave empty. Used only by the developer for testing." } } }, "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 } } } } } } } } } }