{ "openapi": "3.0.1", "info": { "title": "Costco Product Scraper", "description": "Scrape products, categories and item details from Costco Australia.", "version": "0.2", "x-build-id": "FPV2uo4XKWDXY19rL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dromb~costco-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dromb-costco-product-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/dromb~costco-product-scraper/runs": { "post": { "operationId": "runs-sync-dromb-costco-product-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/dromb~costco-product-scraper/run-sync": { "post": { "operationId": "run-sync-dromb-costco-product-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": { "operation": { "title": "Operation", "enum": [ "search", "category", "item", "categories" ], "type": "string", "description": "Operation to perform: search, category, item, or categories.", "default": "search" }, "query": { "title": "Search Query", "type": "string", "description": "Free-text query (e.g., 'tv' or 'olive oil') for searching products." }, "categoryCode": { "title": "Category Code", "type": "string", "description": "Category code or URL (e.g., cos_21.1.2) to filter results or list category products." }, "productCode": { "title": "Product Code", "type": "string", "description": "Product code, slug, or full URL for fetching a single item's details." }, "parentId": { "title": "Parent Category ID", "type": "string", "description": "Return only direct children of this category code when listing categories." }, "level": { "title": "Category Level", "type": "integer", "description": "Filter categories by breadcrumb depth." }, "limit": { "title": "Limit", "type": "integer", "description": "Maximum number of items/categories to return.", "default": 20 }, "page": { "title": "Page", "type": "integer", "description": "Page number for pagination.", "default": 1 }, "sort": { "title": "Sort", "enum": [ "relevance", "name_asc", "name_desc", "price_asc", "price_desc", "top_sellers", "top_rated" ], "type": "string", "description": "Sort order: relevance, name_asc, name_desc, price_asc, price_desc, top_sellers, top_rated.", "default": "relevance" }, "filters": { "title": "Filters", "type": "array", "description": "Facet filters in format 'FacetName:FacetValue'.", "items": { "type": "string" } }, "details": { "title": "Include Details", "type": "boolean", "description": "When true, return richer normalized fields where available.", "default": false }, "refresh": { "title": "Refresh Categories", "type": "boolean", "description": "Refresh category cache from sitemap when listing categories.", "default": false }, "includeNonCos": { "title": "Include Non-COS Categories", "type": "boolean", "description": "Include non-standard category codes (brand/promo buckets) when listing categories.", "default": false }, "rawQuery": { "title": "Raw Query Expression", "type": "string", "description": "Raw Costco query expression. Overrides query/sort/category/filter." }, "proxy": { "title": "Proxy Configuration", "enum": [ "direct", "apify", "custom", "auto" ], "type": "string", "description": "Proxy configuration: 'direct', 'apify', 'custom', or 'auto'.", "default": "auto" }, "customProxyUrl": { "title": "Custom Proxy URL", "type": "string", "description": "URL for custom proxy if 'custom' is selected." }, "proxyCountry": { "title": "Proxy Country", "type": "string", "description": "Country for the proxy (e.g., 'AU').", "default": "AU" } } }, "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 } } }, "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 } } } } } } } } } }