{
"openapi": "3.0.1",
"info": {
"title": "Target Products Scraper",
"description": "Search Target products and find which stores have them in stock across selected states, with per-store quantities.",
"version": "0.1",
"x-build-id": "og8uxc77Ugv75PCtF"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/harpoon~target-products-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-harpoon-target-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/harpoon~target-products-scraper/runs": {
"post": {
"operationId": "runs-sync-harpoon-target-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/harpoon~target-products-scraper/run-sync": {
"post": {
"operationId": "run-sync-harpoon-target-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": {
"search_terms": {
"title": "Search terms (keyword / TCIN / DPCI / UPC / URL)",
"uniqueItems": true,
"type": "array",
"description": "One entry per line. Any of: a keyword (airpods), an exact TCIN (85978619), DPCI (057-10-2490), UPC/barcode (195951378657), or a Target product URL (https://www.target.com/p/-/A-85978619). Each product found is checked at the stores in the states below.",
"items": {
"type": "string"
}
},
"states": {
"title": "States to check",
"uniqueItems": true,
"type": "array",
"description": "Optional. Pick one or more states (use the search box to filter), or Everywhere (all US states) to sweep the whole country. Every store in each selected state is checked, then results are combined. Large states - and especially Everywhere - mean far more stores and requests; start with one small state to gauge timing.
If you leave this empty, a default area is used and only the first 5 stores per product are returned (free).",
"items": {
"type": "string",
"enum": [
"ALL",
"AL",
"AK",
"AZ",
"AR",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VA",
"WA",
"WV",
"WI",
"WY"
],
"enumTitles": [
"Everywhere (all US states)",
"Alabama",
"Alaska",
"Arizona",
"Arkansas",
"California",
"Colorado",
"Connecticut",
"Delaware",
"District of Columbia",
"Florida",
"Georgia",
"Hawaii",
"Idaho",
"Illinois",
"Indiana",
"Iowa",
"Kansas",
"Kentucky",
"Louisiana",
"Maine",
"Maryland",
"Massachusetts",
"Michigan",
"Minnesota",
"Mississippi",
"Missouri",
"Montana",
"Nebraska",
"Nevada",
"New Hampshire",
"New Jersey",
"New Mexico",
"New York",
"North Carolina",
"North Dakota",
"Ohio",
"Oklahoma",
"Oregon",
"Pennsylvania",
"Puerto Rico",
"Rhode Island",
"South Carolina",
"South Dakota",
"Tennessee",
"Texas",
"Utah",
"Vermont",
"Virginia",
"Washington",
"West Virginia",
"Wisconsin",
"Wyoming"
]
}
},
"max_products": {
"title": "Max products",
"minimum": 1,
"maximum": 500,
"type": "integer",
"description": "Cap on how many products are returned from your search. Each product is then checked at every store in the selected states, so a higher number multiplies the work.",
"default": 24
},
"max_stores_per_product": {
"title": "Max stores per product",
"minimum": 1,
"maximum": 25,
"type": "integer",
"description": "Cap on how many stores are checked (and listed) per product. Lower values make a run faster and cheaper. Capped at 25. The first 5 stores per product are included in the base price; additional stores are billed at $1 per 1,000 - see the Pricing tab.",
"default": 25
},
"store_coverage": {
"title": "Store coverage",
"enum": [
"all",
"nearby"
],
"type": "string",
"description": "Only used when States is set.
Every store in the state searches the whole state so no store is missed - thorough but slower, especially for large states.
Nearest stores only checks just the stores nearest the state's center - much faster, but it does not cover every store.",
"default": "all"
},
"include_product_details": {
"title": "Include full product details",
"type": "boolean",
"description": "Adds the UPC/barcode, package dimensions, category path, return policy, purchase limit and gift-wrap eligibility for each product. On by default; turn it off for lighter, faster runs.",
"default": true
},
"include_out_of_stock": {
"title": "Include out-of-stock stores",
"type": "boolean",
"description": "When off (default), only stores that currently have the product in stock are returned. Turn on to also list nearby stores that are sold out.",
"default": false
},
"grid_step_deg": {
"title": "State search density (degrees)",
"minimum": 0.2,
"maximum": 3,
"type": "number",
"description": "Only used by Every store in the state. How finely a state is divided while finding its stores, in degrees (about 69 miles per degree). Smaller is more thorough but makes far more requests. Default 0.6 is a good balance; lower it for dense metro areas, raise it to save cost.",
"default": 0.6
}
}
},
"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
}
}
}
}
}
}
}
}
}
}