{ "openapi": "3.0.1", "info": { "title": "Sutherlands Home Improvement Scraper", "description": "Scrape Sutherlands.com - a US home improvement, hardware, and farm & ranch retail chain. Search or browse products by department/brand/SKU with real store pricing, stock status, specs, and images.", "version": "1.0", "x-build-id": "RtVZupOsakwIGpEUv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~sutherlands-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-sutherlands-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/crawlerbros~sutherlands-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-sutherlands-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/crawlerbros~sutherlands-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-sutherlands-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byCategory", "byBrand", "bySku" ], "type": "string", "description": "What to fetch.", "default": "search" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Free-text keyword search (mode=search), e.g. `cordless drill`, `garden hose`, `chicken coop`.", "default": "drill" }, "department": { "title": "Department / category", "enum": [ "Appliances", "Automotive", "Blinds & Window Treaments", "Building Materials", "Building Packages", "Cleaning", "Clothing, Footwear, & Accessories", "Doors & Windows", "Electrical", "Farm & Ranch", "Flooring, Tile, & Rugs", "Furniture & Décor", "General Merchandise", "Hardware", "Heating, Cooling, & Air Quality", "Holiday Decorations", "Hunting & Sporting Goods", "Kitchen & Bath", "Lawn & Garden", "Lighting & Ceiling Fans", "Outdoor Living & Patio", "Outdoor Power Equipment", "Paint", "Pet Supplies & Wildbird", "Plumbing", "Storage & Organization", "Tools" ], "type": "string", "description": "Restrict results to one department. Required for mode=byCategory; optional narrowing filter for other modes." }, "brandName": { "title": "Brand (exact) — mode=byBrand", "type": "string", "description": "Exact brand name to browse, e.g. `DeWALT®`, `IRWIN`, `HILLMAN®`. Case-sensitive exact match against Sutherlands' brand catalog." }, "skuOrItemNumber": { "title": "SKU / item number — mode=bySku", "type": "string", "description": "Sutherlands SKU / item number to look up, e.g. `4779450`." }, "brandContains": { "title": "Brand contains (filter)", "type": "string", "description": "Only keep records whose brand name contains this text (case-insensitive). Works in any mode." }, "categoryContains": { "title": "Category contains (filter)", "type": "string", "description": "Only keep records whose full category breadcrumb (e.g. `Tools > Hand Tools > Hammers`) contains this text (case-insensitive). Use this to narrow into a subcategory that has no dedicated `department` value. Works in any mode." }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "maximum": 42853, "type": "integer", "description": "Drop products priced below this amount at every carrying store." }, "maxPrice": { "title": "Max price (USD)", "minimum": 0, "maximum": 42853, "type": "integer", "description": "Drop products priced above this amount at every carrying store." }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "Only emit products with on-hand inventory at a Sutherlands store.", "default": false }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Only emit products currently marked on sale at a Sutherlands store.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "popularityDesc", "salesDesc", "nameAsc", "nameDesc" ], "type": "string", "description": "Result ordering.", "default": "relevance" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records. The upstream search index returns at most 1000 matches per query.", "default": 50 } } }, "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 } } } } } } } } } }