{ "openapi": "3.0.1", "info": { "title": "Target Scraper - Products, Prices, Stock, UPC & Ratings", "description": "Scrape target.com by keyword, category or product link: price and sale price, savings, rating, review count, rating histogram, UPC, DPCI, TCIN, brand, specs, package size, online and store stock with aisle, pickup and delivery date. Sort, store and ZIP options. Error rows are free.", "version": "0.1", "x-build-id": "ftFOLforhCy1rt01x" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapewise~target-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapewise-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/scrapewise~target-scraper/runs": { "post": { "operationId": "runs-sync-scrapewise-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/scrapewise~target-scraper/run-sync": { "post": { "operationId": "run-sync-scrapewise-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 keywords", "type": "array", "description": "Product keywords, one per line, for example air fryer or lego. Each keyword is one search on target.com.", "items": { "type": "string" } }, "startUrls": { "title": "Links or TCINs", "type": "array", "description": "Target product links (/p/.../-/A-95046345), category links (/c/.../-/N-5xtb0), search links (/s?searchTerm=...) or TCINs like 95046345.", "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "Featured", "bestselling", "newest", "PriceLow", "PriceHigh", "RatingHigh" ], "type": "string", "description": "Order of the search and category results, same options as the site.", "default": "relevance" }, "zipCode": { "title": "ZIP code (store)", "type": "string", "description": "US ZIP code: the nearest Target store is used for store prices, pickup and in-store stock with aisle. Empty = online prices and stock only." }, "storeId": { "title": "Store number", "type": "string", "description": "Target store number, for example 1375. Takes priority over the ZIP code." }, "minPrice": { "title": "Minimum price (USD)", "minimum": 0, "type": "number", "description": "Skip products cheaper than this. Skipped products are free." }, "maxPrice": { "title": "Maximum price (USD)", "minimum": 0, "type": "number", "description": "Skip products more expensive than this." }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only products with at least this average star rating, for example 4.5." }, "onSaleOnly": { "title": "Only products on sale", "type": "boolean", "description": "On: only products with a sale price below the regular price.", "default": false }, "includeDetails": { "title": "Product details and stock", "type": "boolean", "description": "On: adds UPC, category path, long description, rating histogram, package size, return policy and online and store stock (two small requests per product). Off: rows from the search results only.", "default": true }, "maxItems": { "title": "Max products", "minimum": 0, "type": "integer", "description": "Hard cap for the whole run, across all searches and links. 0 = no cap.", "default": 50 }, "onlyNew": { "title": "Only new products (for schedules)", "type": "boolean", "description": "On: remembers the products delivered in earlier runs of the same search (in your account) and delivers only products not seen before. Skipped products are free.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy by default; the run moves to US residential IPs by itself if Target refuses it.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }