{ "openapi": "3.0.1", "info": { "title": "ShopRite US Scraper: Price Plus, Digital Coupons & Deals", "description": "Get US ShopRite prices for milk, coffee and groceries by ZIP or store: sale prices, Price Plus labels, digital coupons, deal dates, unit prices, stock, UPC and size. About $0.004 per product: 1,000 products cost $4. No login. Missing card-price values stay null.", "version": "1.0", "x-build-id": "dL9Ej9sJnLqehgxrB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moggedhq~shoprite-us-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moggedhq-shoprite-us-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/moggedhq~shoprite-us-scraper/runs": { "post": { "operationId": "runs-sync-moggedhq-shoprite-us-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/moggedhq~shoprite-us-scraper/run-sync": { "post": { "operationId": "run-sync-moggedhq-shoprite-us-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": "Find products such as milk, chicken or coffee. Each term is searched at every selected store. Leave empty when using only URLs or product IDs.", "items": { "type": "string" } }, "startUrls": { "title": "Category, deals or product URLs", "type": "array", "description": "Optional public ShopRite category, results, promotions or product links. Examples: https://www.shoprite.com/sm/planning/rsid/592/categories/meat-id-520692 and https://www.shoprite.com/sm/planning/rsid/592/promotions . The run store selection overrides store IDs in links.", "items": { "type": "string" } }, "productIds": { "title": "Product IDs", "type": "array", "description": "Exact ShopRite SKU/UPC strings from the product URL, for example 00041190467150. Preserve leading zeros. Products are fetched at every selected store.", "items": { "type": "string" } }, "locations": { "title": "ZIP codes", "type": "array", "description": "US ZIP codes, for example 07080 or 10001. Selects the closest live verified ShopRite within 100 miles of the ZIP center. Exact store IDs take precedence. Empty uses the website corporate default store.", "items": { "type": "string" } }, "storeIds": { "title": "Store IDs", "type": "array", "description": "Exact ShopRite store numbers, such as 592 or 225. Verified against the live directory. Preferred for recurring price monitoring; take precedence over ZIPs.", "items": { "type": "string" } }, "maxItemsPerSearch": { "title": "Maximum products per search and store", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum new product rows from each term, category or deals source at one store. Duplicates are free.", "default": 20 }, "maxItems": { "title": "Maximum products in this run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Global limit across all products and stores. About $0.004 per product: 20 products cost about $0.08 plus the small start charge.", "default": 20 }, "dealsOnly": { "title": "Deals only", "type": "boolean", "description": "Keep advertised sale products, explicit member prices, promotions and public UPC-linked digital coupons. Coupon discounts remain separate from price.", "default": false }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Adds store-scoped ingredients, nutrition and aisle when available. Slower product requests; no extra product charge.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Default datacenter first, US residential only after refusals. Uses official Wakefern gateway hosts. Supply custom proxies or disable the proxy if desired.", "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 } } } } } } } } } }