{ "openapi": "3.0.1", "info": { "title": "Target.com Product Scraper", "description": "Scrape Target.com products from search queries or URLs. Optionally enrich with product details and customer reviews.", "version": "1.0", "x-build-id": "tebOrc8ofmAYaNjy6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~target-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-target-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/rigelbytes~target-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-target-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/rigelbytes~target-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-target-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": { "searchQueries": { "title": "Search Queries", "type": "array", "description": "Product search terms to look up on Target.com (e.g. \"socks\", \"tide pods\", \"lego star wars\"). Primary input for AI agents — no URL required. Combine with Start URLs if you want both.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Target.com URLs to scrape instead of or in addition to search queries (e.g. \"https://www.target.com/s?searchTerm=socks\", \"https://www.target.com/c/toys-clearance/-/N-5tg3d\", \"https://www.target.com/p/-/A-14073530\", \"https://www.target.com/weekly-ad\"). Accepts search, category, deals, clearance, product, brand, and weekly-ad pages.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Products", "minimum": 0, "type": "integer", "description": "Maximum number of products to scrape across all queries and URLs (0 = unlimited).", "default": 10 }, "includeProductDetails": { "title": "Include Product Details", "type": "boolean", "description": "When enabled, fetch the full product page for each item (description, specifications, extra images, variants, barcode). Charged as the product-details event in addition to each dataset item.", "default": false }, "includeReviews": { "title": "Include Product Reviews", "type": "boolean", "description": "When enabled, fetch customer reviews for each product. Charged as the product-reviews event in addition to each dataset item.", "default": false }, "maxReviews": { "title": "Max Reviews per Product", "minimum": 0, "type": "integer", "description": "Maximum number of reviews to collect per product when Include Product Reviews is enabled (0 = all, capped internally).", "default": 10 }, "detailConcurrency": { "title": "Detail Concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many products to enrich in parallel (product details and reviews run at the same time per product). Each worker uses its own proxy session and rotates it periodically. Higher is faster; keep it modest to avoid blocks.", "default": 5 }, "storeId": { "title": "Store ID", "type": "string", "description": "Target store ID used for local pricing and weekly ads (e.g. \"3991\" for the online catalog, \"1532\" for a specific store). Leave the default unless you need a particular store's prices.", "default": "3991" }, "zipCode": { "title": "ZIP Code", "type": "string", "description": "US ZIP code sent with listing and product requests (e.g. \"55401\", \"10001\"). Used for store-local pricing context.", "default": "55401" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Apify Residential (US) is recommended for reliable Target access.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }