{ "openapi": "3.0.1", "info": { "title": "Allegro.pl Listings by Search, Category or URL", "description": "Find Allegro.pl products by keyword search, category page, or direct offer URL, with price, seller rating, condition, shipping, and rating details, filterable by price range and free shipping.", "version": "1.0", "x-build-id": "6jqVxUOWUn3BxY9EE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~allegro-pl-listings-by-search-category-or-url/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-allegro-pl-listings-by-search-category-or-url", "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/vexaloom-labs~allegro-pl-listings-by-search-category-or-url/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-allegro-pl-listings-by-search-category-or-url", "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/vexaloom-labs~allegro-pl-listings-by-search-category-or-url/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-allegro-pl-listings-by-search-category-or-url", "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", "byCategory", "bySeller", "byUrl", "byProduct", "reviews", "sellerProfiles" ], "type": "string", "description": "What to scrape. Search by keyword, browse categories or sellers, fetch specific offer/product URLs, get every seller for a product, read product reviews, or build seller profiles.", "default": "search" }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Keywords to search for. One query per line. (mode=search)", "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "Allegro category URLs, or category ids/aliases. (mode=byCategory)", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Offer, product, product-offers, seller or review target URLs. Use this for byUrl, bySeller, byProduct, reviews and sellerProfiles.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "market": { "title": "Market", "enum": [ "pl" ], "type": "string", "description": "Allegro marketplace. Only Poland (allegro.pl) is supported.", "default": "pl" }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "price_asc", "price_desc", "price_with_delivery_asc", "price_with_delivery_desc", "popularity", "ending_soonest", "newest", "product_rating" ], "type": "string", "description": "Order of results for search, category, seller and product-offer listings.", "default": "relevance" }, "condition": { "title": "Condition", "enum": [ "all", "new", "used", "refurbished", "damaged" ], "type": "string", "description": "Filter listings by item condition.", "default": "all" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Lowest price in PLN. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Highest price in PLN. Leave empty for no maximum." }, "freeShippingOnly": { "title": "Free Delivery Only", "type": "boolean", "description": "Use Allegro's free-delivery (Smart!) filter for listing modes.", "default": false }, "buyNowOnly": { "title": "Buy Now Only", "type": "boolean", "description": "Exclude auctions and keep only offers you can buy immediately.", "default": false }, "superSellerOnly": { "title": "Super Seller Only", "type": "boolean", "description": "Keep only offers from Allegro Super Sellers.", "default": false }, "includeSponsored": { "title": "Include Sponsored Offers", "type": "boolean", "description": "Include sponsored placements in listing results. Turn off for organic results only.", "default": true }, "includeDetails": { "title": "Enrich With Offer Details", "type": "boolean", "description": "Open each offer from search, category, seller and product-offer listings to add stock, GTIN, full specs, company identity, warranty and returns. Slower and uses more requests.", "default": false }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 6000, "type": "integer", "description": "Maximum records to return. Listing modes cap each source at 6,000 offers (100 pages).", "default": 100 }, "maxReviewsPerProduct": { "title": "Max Reviews Per Product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum reviews to collect for each product in reviews mode.", "default": 100 } } }, "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 } } } } } } } } } }