{ "openapi": "3.0.1", "info": { "title": "H-E-B Scraper: Store Prices, Deals, Aisles & Stock by ZIP", "description": "Scrape H-E-B (heb.com) products and prices for any Texas store by ZIP code or store number: shelf, sale, curbside and unit prices, weekly ad and digital coupon flags, aisle location, stock, UPC, size and SNAP eligibility. Search terms, categories or product URLs. Pay per product.", "version": "0.1", "x-build-id": "aoc7WtbwFrJBYVbgQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~heb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-heb-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/zaiq~heb-scraper/runs": { "post": { "operationId": "runs-sync-zaiq-heb-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/zaiq~heb-scraper/run-sync": { "post": { "operationId": "run-sync-zaiq-heb-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Words to search for on heb.com, as a shopper would type them (for example milk, organic eggs, sourdough bread). Each term is searched at every store.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Prices differ by store. Texas ZIP codes. Each ZIP code gives the nearest H-E-B stores (also Central Market, Joe V's and Mi Tienda) within 50 miles; set how many with Stores per ZIP code.", "items": { "type": "string" } }, "storeIds": { "title": "Store IDs", "type": "array", "description": "Optional, instead of or as well as ZIP codes. H-E-B store numbers such as 754 (SoCo H-E-B, Austin) or 744 (Buffalo Heights, Houston). The store number is shown on each row as storeId.", "items": { "type": "string" } }, "storesPerZip": { "title": "Stores per ZIP code", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many of the nearest stores to scrape for each ZIP code (nearest first).", "default": 1 }, "categoryUrls": { "title": "Category URLs", "type": "array", "description": "Optional. Category pages from heb.com, such as https://www.heb.com/category/shop/dairy-eggs/milk/490016/490053 (the last two numbers identify the category).", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or IDs", "type": "array", "description": "Optional. Product pages such as https://www.heb.com/product-detail/h-e-b-reduced-fat-2-milk-1-gal/314125, or H-E-B product numbers such as 314125. Each is checked at every store.", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Max products per search or category", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop each search term or category after this many products at each store. Pages are followed until then.", "default": 100 }, "maxItems": { "title": "Max products in total", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "The run stops after this many product rows. 0 means no limit (your spending limit still applies).", "default": 1000 }, "onSaleOnly": { "title": "Deals only", "type": "boolean", "description": "Only products on sale, in the weekly ad, with a price cut or with a digital coupon.", "default": false }, "includeDetails": { "title": "Product details", "type": "boolean", "description": "Also open each product's page: adds the aisle number (for example 'In Dairy on the Back Wall, A25'), digital coupon details, the full category path and nutrition-related text. One extra request per product.", "default": false }, "includeFailures": { "title": "List failures in the results", "type": "boolean", "description": "Add a free row (with an error field) for each ZIP code without a store, search without results or product that could not be read. Switch off to keep only product rows.", "default": true }, "maxConcurrency": { "title": "Jobs at once", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many searches, categories or product lists run at the same time.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "US residential proxies are used by default (the sites serve US visitors).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }