{ "openapi": "3.0.1", "info": { "title": "Costco Scraper ā€” Product Search, Details & Price API", "description": "Scrape Costco.com at scale: keyword product search and full product details by item number. Real-time sale/list/per-unit prices, ratings, stock, brand and SKUs in one clean JSON dataset. API-backed and reliable ā€” built for price monitoring, price tracking and catalog enrichment.", "version": "1.0", "x-build-id": "5AmIBzmb6q7V8Gn6k" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~costco-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-costco-data-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/sian.agency~costco-data-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-costco-data-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/sian.agency~costco-data-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-costco-data-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": [ "operation" ], "properties": { "operation": { "title": "šŸŽÆ Operation ā€” what do you want to scrape?", "enum": [ "search", "productDetails" ], "type": "string", "description": "šŸŽÆ **PICK ONE OPERATION PER RUN.** Each run produces one clean dataset matching the chosen mode.\n\n- **šŸ” Product Search** ā€” keyword search across Costco products, paginated (~24 results/page)\n- **šŸ“¦ Product Details** ā€” full details of a single product by its Costco item number (price, ratings, stock, brand, marketing features, SKUs)\n\nšŸ’” **TIP:** Run Product Search to discover item numbers, then drill into Product Details per item.", "default": "search" }, "query": { "title": "šŸ” Search Query (for Product Search)", "type": "string", "description": "šŸ” **Required for `Product Search` operation.**\n\nAny Costco product search query.\n- `paper towels`\n- `kirkland signature olive oil`\n- `air fryer`\n\nšŸ’” **TIP:** Long-tail queries return higher-relevance results.\n\nāš ļø **Ignored** for Product Details." }, "productId": { "title": "šŸ“¦ Item Number (for Product Details)", "type": "string", "description": "šŸ“¦ **Required for `Product Details` operation.**\n\nThe Costco product / item number ā€” the numeric ID that identifies a product.\n- `512599`\n\nIt appears as the `itemNumber` field in any Product Search result row, and in Costco product URLs: `https://www.costco.com/.product.{itemNumber}.html`.\n\nšŸ’” **TIP:** Run `Product Search` first to discover item numbers, then loop through Product Details per item.\n\nāš ļø **Ignored** for Product Search." }, "country": { "title": "šŸŒ Country (Costco domain)", "enum": [ "US", "CA" ], "type": "string", "description": "šŸŒ Which Costco country / domain to query. `US` = costco.com (default), `CA` = costco.ca.", "default": "US" }, "language": { "title": "šŸ—£ļø Language", "type": "string", "description": "Result language. Defaults to the major language for the chosen country (e.g. `en-US` for US). Examples: `en-US`, `fr-CA`.", "default": "en-US" }, "maxPages": { "title": "šŸ“„ Max pages to fetch", "minimum": 1, "maximum": 50, "type": "integer", "description": "šŸ“„ **Applies to `Product Search` only** (~24 products per page). Ignored for Product Details.\n\nšŸ’” **TIP:** Start small (1ā€“3 pages) to preview results before scaling up. Pagination stops automatically when the data source reports no more results.\n\nāš ļø Hard cap: 50 pages to prevent runaway runs.\n\nā±ļø **Note:** Costco responses can take 1ā€“2 minutes per page ā€” large page counts may run long.", "default": 5 } } }, "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 } } } } } } } } } }