{ "openapi": "3.0.1", "info": { "title": "At Home Scraper - Furniture, Decor & Rugs", "description": "Scrape At Home (athome.com), the US home-decor superstore. Search products by keyword, browse by department (Furniture, Rugs, Lighting, Outdoor, and more), or fetch by direct product URL. Get prices, sale status, images, dimensions, ratings, and full category breadcrumbs.", "version": "1.0", "x-build-id": "aznsivFYHnVmWdFwc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~athome-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-athome-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~athome-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-athome-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~athome-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-athome-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", "byUrls" ], "type": "string", "description": "What to fetch: keyword search across product titles, browse a department, or fetch specific products by URL.", "default": "search" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Free-text keyword(s) to search for in product titles, e.g. 'rug', 'table lamp', 'throw pillow' (mode=search). Matches against the full product catalog.", "default": "rug" }, "department": { "title": "Department", "enum": [ "furniture", "outdoor", "rugs", "wall-decor", "home-decor", "pillows", "kitchen-dining", "bed-bath", "window", "lighting", "storage-organization", "holiday" ], "type": "string", "description": "Home-decor department to browse (mode=byCategory). Results are verified against each product's real category breadcrumb.", "default": "furniture" }, "productUrls": { "title": "Product URLs (mode=byUrls)", "type": "array", "description": "Direct athome.com product page URLs to fetch, e.g. https://www.athome.com/mr.-clean-angle-broom/123569083.html.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "athome.com product URL." } } }, "default": [] }, "minPrice": { "title": "Minimum price (USD)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only return products priced at or above this amount. 0 means no minimum. Applied client-side after fetch.", "default": 0 }, "maxPrice": { "title": "Maximum price (USD)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Only return products priced at or below this amount. 0 means no maximum. Applied client-side after fetch.", "default": 0 }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only return products rated at least this many stars, e.g. 4 for 4.0+. 0 means no minimum. Products with no rating are excluded once this is set above 0.", "default": 0 }, "color": { "title": "Filter by color", "type": "string", "description": "Only return products whose color contains this text (case-insensitive), e.g. 'blue', 'ivory', 'black'. Only some athome.com products (e.g. pillows, throws) expose a color attribute -- products without one always pass this filter." }, "material": { "title": "Filter by material", "type": "string", "description": "Only return products whose material contains this text (case-insensitive), e.g. 'wood', 'metal', 'polyester', 'glass'. Most athome.com products expose a material attribute -- products without one always pass this filter." }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Only return products currently marked with a sale price.", "default": false }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "Only return products currently in stock.", "default": false }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "price-asc", "price-desc", "rating-desc", "popularity-desc", "newest" ], "type": "string", "description": "How to order results after fetching. athome.com's own search/browse pages aren't reachable server-side, so sorting is applied client-side across the fetched batch.", "default": "relevance" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on the number of products to return.", "default": 20 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Product pages are reliably reachable without a proxy; this is used only as an automatic fallback if a fetch is transiently blocked.", "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 } } }, "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 } } } } } } } } } }