{ "openapi": "3.0.1", "info": { "title": "ASOS Scraper - Product Prices, Sizes & Categories", "description": "Extract ASOS product prices, brands, sizes and links by keyword, category or product across selected country markets. Includes category and sitemap rows. Pay per delivered row plus a start fee.", "version": "0.2", "x-build-id": "n7ujDvEmD9440LsAj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~asos-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-asos-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~asos-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-asos-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~asos-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-asos-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", "categorySearch", "keywordSearch", "productDetail", "categories", "sitemap", "facetSitemap" ], "type": "string", "description": "Auto picks the mode from what you fill in: a product link or ID gives product detail, a category ID or bucket gives the category listing, a search query gives keyword search. Pick a mode yourself for the category taxonomy or the sitemap inventory, which need no other field.", "default": "auto" }, "query": { "title": "Search query", "type": "string", "description": "Words to search for on ASOS, e.g. black dress." }, "productUrl": { "title": "Product URL", "pattern": "^.*/prd/[0-9]+.*$", "type": "string", "description": "Link to one ASOS product page (any ASOS country site), e.g. https://www.asos.com///prd/123456789." }, "productId": { "title": "Product ID", "pattern": "^[0-9]+$", "type": "string", "description": "ASOS product number, e.g. 123456789 (the digits after /prd/ in a product link)." }, "colourWayId": { "title": "Colour way ID", "pattern": "^[0-9]*$", "type": "string", "description": "Optional colour identifier for a product-detail request. Leave empty to use the product selection returned by ASOS." }, "cid": { "title": "Category ID (cid)", "pattern": "^[0-9]+$", "type": "string", "description": "ASOS category number (the cid= value in a category page link), e.g. 8799." }, "bucket": { "title": "Category bucket", "enum": [ "sale", "new_in", "face_body", "clothing", "shoes", "accessories", "activewear", "brands", "outlet", "other" ], "type": "string", "description": "Choose a category group, such as sale or clothing. Used for category searches and to filter the category list." }, "categorySlug": { "title": "Category slug", "type": "string", "description": "Category URL slug, such as dresses. Use with a category ID; a slug alone does not select a category search." }, "categoryPath": { "title": "Category path", "type": "string", "description": "Category URL path, such as women/sale. Use with a category ID or bucket; a path alone does not select a category search." }, "gender": { "title": "Gender", "enum": [ "women", "men" ], "type": "string", "description": "Choose women or men for category searches and category lists.", "default": "women" }, "sitemapKind": { "title": "Sitemap kind", "enum": [ "product", "facet" ], "type": "string", "description": "Choose product for product links, or facet for category links with filter values. Used in sitemap mode.", "default": "product" }, "browseCountry": { "title": "Browse country", "pattern": "^([A-Za-z]{2}|ROW|row)$", "type": "string", "description": "ASOS country code, such as GB, US, AU or DE, or ROW for rest of world. Product availability and fields vary by market.", "default": "GB" }, "currency": { "title": "Currency", "type": "string", "description": "Optional currency code, such as GBP or USD. Leave empty to use the selected market currency." }, "refine": { "title": "Refine filter", "type": "string", "description": "ASOS filter expression copied from a category link, such as attribute_10992:61379. Available filters depend on the category." }, "sort": { "title": "Sort", "enum": [ "freshness", "pricedasc", "priceddesc", "favourite", "trending" ], "type": "string", "description": "Choose the listing order: newest, price low to high, price high to low, most saved or trending." }, "currentPriceRange": { "title": "Price range", "type": "string", "description": "Price-range value copied from the currentpricerange parameter of an ASOS listing URL." }, "maxResults": { "title": "Max results per search, category, or product input", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum rows for the one input in this run, from 1 to 500; default 70. Extra colour rows share this limit, and the maximum run cost also applies. Free plan: up to 200 rows per run and 10 runs of this Actor.", "default": 70 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum listing pages or sitemap pages to read, from 1 to 50. The row limit may stop collection earlier.", "default": 1 }, "enrichDetails": { "title": "Add product details", "type": "boolean", "description": "Add available product details to a limited number of search or category rows. For product sitemap rows, request available price and stock information.", "default": false }, "expandColours": { "title": "Include alternate colour rows", "type": "boolean", "description": "Request extra product rows for alternate colours after a listing is exhausted and the row limit has room. Each delivered colour row counts toward the limit and is billed at the normal row price.", "default": false }, "includeRelated": { "title": "Include related products", "type": "boolean", "description": "Retain available related-product references within product details. This does not run a separate related-product search.", "default": false }, "workerBaseUrl": { "title": "Developer testing", "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 } } } } } } } } } }