{ "openapi": "3.0.1", "info": { "title": "Fashion Retail Market Data API - Prices, Discounts, Stock", "description": "Read product-level fashion, beauty and home retail market data: current and full price, advertised discount, stock, sell-out, colour, pattern, fabric and category for each product option, by retailer, brand, market and week. Competitor pricing and assortment intelligence. Bring your own key.", "version": "0.1", "x-build-id": "zQftpzfl99ZrgfoTx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~fashion-retail-market-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-fashion-retail-market-data-api", "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/nabeelbaghoor~fashion-retail-market-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-fashion-retail-market-data-api", "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/nabeelbaghoor~fashion-retail-market-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-fashion-retail-market-data-api", "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": { "retailers": { "title": "Retailers", "type": "array", "description": "Retailer names or slugs, one per line, such as Zara, H&M, ASOS or zara. Each is looked up with the provider's retailer search and then searched on its own, so each retailer gets up to 50 product options. A retailer trades as a separate entry in each country, so set the market to pick one country. Leave empty to search across all retailers.", "items": { "type": "string" } }, "market": { "title": "Market", "type": "string", "description": "Two-letter retailer market code, such as UK, US, DE, FR or ES. GB is accepted for the UK. Also narrows the retailer lookup to that country." }, "category": { "title": "Product category", "type": "string", "description": "A category name such as dresses, jeans, sneakers, knitwear or mascara, looked up in the provider's category tree, or a numeric category id. A category includes everything beneath it, so Tops includes T-Shirts." }, "brands": { "title": "Brands", "type": "array", "description": "Brand names, one per line, such as Nike, Levi's or Hugo Boss. Matched as a case-insensitive phrase on the brand name, which also catches brands the provider has not normalised. At most 50.", "items": { "type": "string" } }, "genders": { "title": "Gender", "type": "array", "description": "Keep only products for these genders.", "items": { "type": "string", "enum": [ "women", "men", "unisex-adults", "girls", "boys", "unisex-kids" ], "enumTitles": [ "Women", "Men", "Unisex adults", "Girls", "Boys", "Unisex kids" ] } }, "productNameQuery": { "title": "Product name search", "type": "string", "description": "Full-text search on the product name. Words are AND-combined; use uppercase OR and NOT, and wrap a phrase in double quotes, for example: midi OR maxi, or \"wrap dress\"." }, "colours": { "title": "Colours", "type": "array", "description": "Keep only products whose predominant colour is one of these.", "items": { "type": "string", "enum": [ "black", "grey", "maroon", "red", "pink", "fuchsia", "purple", "blue", "navy", "teal", "aqua", "green", "lime", "yellow", "orange", "copper", "brown", "gold", "neutral", "silver", "white" ], "enumTitles": [ "Black", "Grey", "Maroon", "Red", "Pink", "Fuchsia", "Purple", "Blue", "Navy", "Teal", "Aqua", "Green", "Lime", "Yellow", "Orange", "Copper", "Brown", "Gold", "Neutral", "Silver", "White" ] } }, "patterns": { "title": "Patterns", "type": "array", "description": "Keep only products whose predominant pattern is one of these.", "items": { "type": "string", "enum": [ "plain", "abstract", "animal", "aztec", "camouflage", "checks", "conversational", "floral", "geometric", "graphics", "lace", "paisley", "spots", "stripes", "tile" ], "enumTitles": [ "Plain", "Abstract", "Animal", "Aztec", "Camouflage", "Checks", "Conversational", "Floral", "Geometric", "Graphics", "Lace", "Paisley", "Spots", "Stripes", "Tile" ] } }, "materials": { "title": "Fabric contains", "type": "array", "description": "Keep only products whose fabric composition contains one of these materials.", "items": { "type": "string", "enum": [ "cotton", "organic cotton", "wool", "silk", "linen", "cashmere", "leather", "calf leather", "suede", "viscose", "acetate", "rayon", "polyester", "recycled polyester", "elastane", "polyamide", "nylon", "spandex", "polyurethane", "acrylic", "rubber" ], "enumTitles": [ "Cotton", "Organic Cotton", "Wool", "Silk", "Linen", "Cashmere", "Leather", "Calf Leather", "Suede", "Viscose", "Acetate", "Rayon", "Polyester", "Recycled Polyester", "Elastane", "Polyamide", "Nylon", "Spandex", "Polyurethane", "Acrylic", "Rubber" ] } }, "tiers": { "title": "Retailer tier", "type": "array", "description": "Keep only retailers in these market segments.", "items": { "type": "string", "enum": [ "value", "mass", "premium", "luxury" ], "enumTitles": [ "Value", "Mass", "Premium", "Luxury" ] } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Lowest current selling price, in normal currency units (49.99 means 49.99 in the chosen currency)." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Highest current selling price, in normal currency units." }, "minDiscountPercent": { "title": "Minimum discount %", "minimum": 0, "maximum": 100, "type": "number", "description": "Keep only products currently advertised at this discount or deeper, on a 0 to 100 scale (30 means 30% off)." }, "minSelloutPercent": { "title": "Minimum sell-out %", "minimum": 0, "maximum": 100, "type": "number", "description": "Keep only products with at least this share of their sizes sold out, on a 0 to 100 scale. Sort by sell-out to find bestsellers." }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "Keep only products with at least one size available.", "default": false }, "discountedOnly": { "title": "Discounted only", "type": "boolean", "description": "Keep only products currently advertised as discounted.", "default": false }, "launchedSince": { "title": "Launched on or after", "type": "string", "description": "Keep only products first found on or after this date, written as YYYY-MM-DD. Use it for new arrivals." }, "date": { "title": "Snapshot date", "type": "string", "description": "The week to read, written as YYYY-MM-DD. The provider serves one weekly summary per product, for the week containing this date, up to two years back. Leave blank for the current week." }, "sortBy": { "title": "Sort by", "enum": [ "default", "advertised_discount_percentage", "deepest_advertised_discount_percentage", "first_advertised_discount_percentage", "first_price", "full_price", "normalised_average_rating", "number_of_reviews", "price", "sellout_percentage", "sku_count" ], "type": "string", "description": "Which products come first when more match than are returned. The provider returns at most 50 per retailer, so sorting chooses which 50.", "default": "default" }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Highest first or lowest first.", "default": "desc" }, "vertical": { "title": "Vertical", "enum": [ "default", "apparel", "beauty", "homeware" ], "type": "string", "description": "The data segment to search. Leave on account default unless your key covers several and you want a different one.", "default": "default" }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter ISO 4217 code, such as USD, GBP or EUR, for all prices in and out. Leave blank for your account default." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many product options across all retailers. Each retailer returns up to 50.", "default": 50 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key for the EDITED market data API, issued by the provider to customer accounts. This actor is bring-your-own-key and never ships a key of its own. Leave blank to use the DATA_API_KEY environment secret instead." }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Override the host the actor calls. Only useful for testing against a different environment." } } }, "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 } } } } } } } } } }