{ "openapi": "3.0.1", "info": { "title": "Allegro.pl Product Scraper", "description": "Scrape Allegro.pl products by keyword, category, seller or offer URL: price, delivery, seller, rating, sales count, stock, GTIN and specs, plus optional B2B seller leads with NIP, REGON, KRS, address, phone and email.", "version": "1.0", "x-build-id": "Dr3jcBo1Pc5triz7L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~allegro-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-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/parsebird~allegro-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-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/parsebird~allegro-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Enter what you would type into the Allegro search box, one keyword per line. Each keyword runs its own search with its own product limit.", "default": [ "laptop gaming" ], "items": { "type": "string" } }, "startUrls": { "title": "Allegro URLs", "type": "array", "description": "Paste allegro.pl offer pages (/oferta/...), search results (/listing?string=...), categories (/kategoria/...) or seller storefronts (/uzytkownik/...). Filters already in the URL are kept.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItemsPerQuery": { "title": "Max products per keyword or URL", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop each keyword or listing URL after this many products. Allegro shows up to 100 pages (about 6,000 products) per search or category.", "default": 100 }, "minPrice": { "title": "Minimum price (PLN)", "minimum": 0, "type": "integer", "description": "Only products from this price in złoty. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum price (PLN)", "minimum": 0, "type": "integer", "description": "Only products up to this price in złoty. Leave empty for no maximum." }, "condition": { "title": "Condition", "enum": [ "all", "new", "used" ], "type": "string", "description": "Pick new (nowe) or used (używane) products only.", "default": "all" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "price-asc", "price-desc", "newest" ], "type": "string", "description": "Order of results, same as the Allegro sort menu.", "default": "relevance" }, "scrapeProductDetails": { "title": "Scrape full product details", "type": "boolean", "description": "Open each offer page and add exact stock, GTIN/EAN, rating breakdown, warranty, return policy, breadcrumbs, grouped specs, full description and full-size images. Charged as an extra 'Product details' event per product, only when the offer page was read. Slower: one extra page per product.", "default": false }, "includeRawData": { "title": "Include raw Allegro offer data", "type": "boolean", "description": "Attach Allegro's full original offer object to each row. Works with 'Scrape full product details'.", "default": false }, "scrapeSellerContact": { "title": "Collect seller lead data", "type": "boolean", "description": "Add the company seller's legal name, NIP, REGON, KRS, address and the phone and email the seller publishes on Allegro. One lookup per company seller. Private sellers have no company data.", "default": false }, "enrichEmails": { "title": "Find seller emails off-platform", "type": "boolean", "description": "When a company seller shows no email on Allegro, find its website through its NIP and legal name and take the email from that site. An email is kept only when the site shows the same NIP, or the exact legal name with the registered address. Polish companies only. Turns on 'Collect seller lead data'.", "default": false }, "geoCode": { "title": "Proxy country", "type": "string", "description": "Two-letter country of the residential proxy. Keep pl: Allegro.pl shows Polish prices and blocks most traffic from abroad.", "default": "pl" } } }, "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 } } } } } } } } } }