{ "openapi": "3.0.1", "info": { "title": "Costco Products Scraper", "description": "Scrape public Costco product search, category, and product-page data for pricing, stock, ratings, images, and catalog research.", "version": "0.1", "x-build-id": "l1mbotuzrIOfMFhpk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~costco-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-costco-products-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/fetch_cat~costco-products-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-costco-products-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/fetch_cat~costco-products-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-costco-products-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": { "keywords": { "title": "Search keywords", "maxItems": 100, "type": "array", "description": "Costco search terms such as laptop, coffee, vitamins, or hair care. The schema default and Console prefill are laptop; use [] to disable keywords for URL-only requests. Use at most 100 total keywords and URLs.", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "default": [ "laptop" ] }, "startUrls": { "title": "Costco URLs", "maxItems": 100, "type": "array", "description": "Costco search, category or product URLs, as URL objects or strings. Remote request-list URLs are not supported. The schema default is empty; the Console prefills Hair Care. Remove that prefill for keyword-only requests. URLs are processed before keywords and share the total product cap.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchUrls": { "title": "Search/category URLs (simple list)", "maxItems": 100, "type": "array", "description": "Optional plain string list of absolute HTTP(S) Costco search or category URLs. Use at most 100 total keywords and URLs.", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "default": [] }, "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on product records saved to the dataset.", "default": 25 }, "maxItemsPerStartUrl": { "title": "Maximum products per source", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on product records from each keyword or URL.", "default": 25 }, "maxSearchPagesPerStartUrl": { "title": "Maximum search pages per source", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum search pages per keyword or category, from 1 to 50. When public search is unavailable, bounded discovery checks up to 24 candidate product pages per requested page, at most 120 per source, from one public sitemap. It is not complete or ranked search; category matches are checked against product breadcrumbs.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Direct by default, including when this field is omitted. Set useApifyProxy to true for managed proxies, optionally with apifyProxyGroups and apifyProxyCountry; or supply proxyUrls with HTTP(S) customer proxies. Selected settings apply to every Costco request and may add costs; they do not guarantee better coverage. Explicit useApifyProxy:false overrides stale managed group/country fields; a nonempty customer proxy pool is a separate explicit choice. Do not combine a customer pool with enabled managed proxies or nonempty managed group/country fields. Customer pools rotate per request. Only the chosen connection is used: there is no automatic proxy, direct or alternate paid fallback. Unsupported or malformed settings are rejected. Existing saved proxy settings continue to work without user action; active selected proxies produce a brief informational run notice.", "default": { "useApifyProxy": false } }, "debug": { "title": "Save debug evidence", "type": "boolean", "description": "Save bounded blocked search-response snippets to the key-value store for troubleshooting. Off by default; this does not save every response or guarantee a diagnostic file for every failure.", "default": false } } }, "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 } } } } } } } } } }