{ "openapi": "3.0.1", "info": { "title": "YouCan Store Catalog & Price Scraper", "description": "Products, prices, discounts and variants from any YouCan store (Saudi Arabia, Gulf, Morocco, North Africa). Uses the store's own public product feed - HTTP only, no browser, no key.", "version": "0.1", "x-build-id": "ZBHZYj6fIhchFLcIU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abdulwhab95~youcan-store-catalog-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abdulwhab95-youcan-store-catalog-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/abdulwhab95~youcan-store-catalog-scraper/runs": { "post": { "operationId": "runs-sync-abdulwhab95-youcan-store-catalog-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/abdulwhab95~youcan-store-catalog-scraper/run-sync": { "post": { "operationId": "run-sync-abdulwhab95-youcan-store-catalog-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", "required": [ "stores" ], "properties": { "stores": { "title": "Stores", "type": "array", "description": "One store per line - the store's domain or any link on it.", "default": [ "youcan.supply" ], "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop after delivering this many rows from each store (rows filtered out by 'Only discounted products' do not count). With 'Only changes' on, it caps the products checked instead, so a quiet store is not read to its last page on every run.", "default": 1000 }, "onlyOnSale": { "title": "Only discounted products", "type": "boolean", "description": "Return only products whose price is genuinely below the compare-at price.", "default": false }, "includeVariants": { "title": "Include variant prices", "type": "boolean", "description": "Add each product's variants (id, options, price, compare-at price, SKU, barcode, weight, image) as a nested 'variants' list on the same row - still one row, one charge, per product. Asks the same product-list request for include=variants; no extra requests. YouCan publishes no stock or availability per variant, so none is returned. Up to 1000 variants per product; 'variantsComplete' is false when the list is cut short or the store left it out. With 'Only changes', variant price changes are detected too, against a separate snapshot, so the first run with this option on returns every product as NEW.", "default": false }, "includeVariantStock": { "title": "Include variant stock", "type": "boolean", "description": "Needs 'Include variant prices'. Adds inventoryQuantity and inStock to each variant, read from the product's public page - one extra page request per product (skipped for products 'Only discounted products' drops). inventoryQuantity is given only when the product tracks inventory; inStock only when the page states it. A page that is blocked by robots.txt, off the store's own domain, failing or in an unknown layout leaves both null, and stockSource null. With 'Only changes', stock changes are detected too, against a separate snapshot, so the first run with this option on returns every product as NEW.", "default": false }, "onlyChanges": { "title": "Only changes since the last run", "type": "boolean", "description": "Return only products that are new, or whose price or compare-at price changed since the last run that read the store completely. Rows carry changeType (NEW/UPDATED) and previousPrice. The first run returns every product as NEW. YouCan's feed has no stock level, so stock changes cannot be detected.", "default": false }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store that keeps each store's last snapshot for 'Only changes'. Use a different name to keep separate monitors apart.", "default": "youcan-catalog-state" } } }, "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 } } } } } } } } } }