# Crate & Barrel Product Scraper (`sian.agency/crate-and-barrel-product-scraper`) Actor Scrape Crate & Barrel products โ€” price, ratings, images, colors, dimensions & full descriptions. Keyword or category search, detail enrichment, clean JSON/CSV, no code. - **URL**: https://apify.com/sian.agency/crate-and-barrel-product-scraper.md - **Developed by:** [SIรN Oรœ](https://apify.com/sian.agency) (community) - **Categories:** E-commerce, Business - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $4.75 / 1,000 overview products This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Crate & Barrel Product Scraper โ€” Prices, Specs & Dimensions ๐Ÿ›‹๏ธ [![SIรN Agency Store](https://img.shields.io/badge/Store-SI%C3%81N%20Agency-1AE392)](https://apify.com/sian.agency?fpr=sian) [![Home Depot Product Scraper](https://img.shields.io/badge/Store-Home%20Depot%20Product%20Scraper-F96302)](https://apify.com/sian.agency/home-depot-product-scraper?fpr=sian) [![Google Shopping Price Scraper](https://img.shields.io/badge/Store-Google%20Shopping%20Price%20Scraper-4285F4)](https://apify.com/sian.agency/google-shopping-price-scraper?fpr=sian) [![Walmart Product Scraper](https://img.shields.io/badge/Store-Walmart%20Product%20Scraper-0071CE)](https://apify.com/sian.agency/walmart-data-scraper?fpr=sian) #### ๐ŸŽ‰ Pull Crate & Barrel prices, sale flags, ratings, color options, and full dimensions โ€” by keyword or category, no code ##### Built for retail analysts, interior designers, e-commerce sellers, and brands who need fresh Crate & Barrel product data on demand --- ### ๐Ÿ“‹ Overview **Track every price, sale, and product spec on Crate & Barrel โ€” without writing a single line of code.** This scraper turns any Crate & Barrel search or category into a clean, structured spreadsheet of products, complete with prices, ratings, images, color options, and full furniture dimensions. **Why professionals choose us:** - โœ… **Complete product data**: price, sale price, regular price, rating, review count, color options, images, and more - โšก **Fast search-first mode**: pull up to ~100 products per search in seconds; scale across multiple searches - ๐ŸŽจ **Color & variant options**: capture every available color / finish for each product - ๐Ÿ’ฐ **Pay only for results**: charged per product you actually receive โ€” no wasted spend, free tier to test - ๐Ÿ’Ž **Detail enrichment**: add the long description, feature highlights, full dimensions table, and care instructions with one switch - โœจ **Native sorting & filters**: sort by price, rating, best-selling, or newest, and apply the site's own facet filters โ€” just like the Crate & Barrel site --- ### โœจ Features - ๐Ÿ”Ž **Keyword & Category Search**: scrape any Crate & Barrel search term or category page - ๐Ÿท๏ธ **Full Pricing**: current price, price range, regular/was price, and sale flags - โญ **Ratings & Reviews**: star rating and total review count for every product - ๐ŸŽจ **Color Options**: every available color / finish variant per product - ๐Ÿ“ **Dimensions Table**: full structured measurements (Detail mode) โ€” overall, seat, frame, and more - ๐Ÿ–ผ๏ธ **Product Images**: all product image URLs, ready for catalogs, moodboards, or feeds - ๐Ÿงพ **Long Descriptions & Highlights**: complete product copy and feature bullets (Detail mode) - ๐Ÿงผ **Care Instructions**: cleaning and maintenance guidance per product (Detail mode) - ๐Ÿงญ **Breadcrumbs & Categories**: the product's full category path for clean classification - ๐Ÿ“ฆ **Clean Export**: results delivered as structured JSON or CSV, ready for Excel or your database - ๐Ÿš€ **No-Code Setup**: configure searches in a simple form โ€” no scripts, no maintenance --- ### ๐ŸŽฌ Quick Start Enter one or more search keywords, pick a mode, and run. In under a minute you'll have a structured dataset of Crate & Barrel products you can download as JSON or CSV. No setup, no code. ```bash curl -X POST https://api.apify.com/v2/acts/sian.agency~crate-and-barrel-product-scraper/runs?token=YOUR_TOKEN \ -H 'Content-Type: application/json' \ -d '{"keywords": ["sofa"], "scrapeMode": "overview"}' ```` *** ### ๐Ÿš€ Getting Started (3 Simple Steps) #### Step 1: Add Your Searches Type one or more Crate & Barrel search keywords (e.g. `sofa`, `dining table`, `area rug`) โ€” one per line. #### Step 2: Choose Your Mode Pick **Overview** for fast search results, or **Detail** to also pull the long description, full dimensions table, highlights, and care instructions. #### Step 3: Run & Download Click **Start**, then export your results as JSON, CSV, or Excel from the Apify dataset. **That's it! In just a few minutes, you'll have:** - A clean table of Crate & Barrel products with prices and sale flags - Ratings, review counts, color options, and product images - Full dimensions and descriptions in Detail mode *** ### ๐Ÿ“ฅ Input Configuration | Field | Type | Required | Description | |-------|------|----------|-------------| | keywords | array | No | Crate & Barrel search terms, one per item (e.g. `sofa`) | | categories | array | No | Advanced โ€” Crate & Barrel category paths from a category URL | | scrapeMode | string | No | `overview` (fast search) or `detail` (adds description, dimensions, care) | | sort | string | No | `best_match`, `price_low`, `price_high`, `rating`, `best_selling`, or `newest` | | filters | array | No | Advanced โ€” on-site facet filters as `key=value` (e.g. `color=Blue`) | | maxResults | integer | No | Maximum products to return across all searches | **Example โ€” fast search:** ```json { "keywords": ["sofa", "dining table"], "scrapeMode": "overview", "sort": "best_selling", "maxResults": 100 } ``` **Example โ€” full detail with dimensions:** ```json { "keywords": ["area rug"], "scrapeMode": "detail", "sort": "rating", "filters": ["color=Blue"], "maxResults": 50 } ``` *** ### ๐Ÿ“ค Output Results are saved to the Apify dataset with rich fields per product, including: | Field | Type | Description | |-------|------|-------------| | productTitle | string | Product name | | brand | string | Collection / brand name (Detail mode) | | price | number | Current price (low end of any range) | | price\_max | number | High end of a price range, when applicable | | regular\_price | number | List/was price before a markdown | | on\_sale | boolean | Whether the product is currently on sale | | rating | number | Average star rating | | review\_count | number | Total number of reviews | | colors | array | Available color / finish options | | images | array | All product image URLs | | description | string | Long product description (Detail mode) | | highlights | array | Feature highlight bullets (Detail mode) | | dimensions | object | Full measurements table (Detail mode) | | care | array | Care / maintenance instructions (Detail mode) | | breadcrumbs | array | Full category path (Detail mode) | **Example:** ```json { "sku": "322117", "productTitle": "Lounge 93\" Sofa", "brand": "Lounge Collection", "url": "https://www.crateandbarrel.com/lounge-93-sofa/s322117", "price": 2249.0, "regular_price": 2249.0, "on_sale": false, "rating": 4.5, "review_count": 3326, "colors": ["Taft Cement", "Mossa Chai", "View White"], "images": ["https://cb.scene7.com/is/image/Crate/LoungeSofa93inTCSOSSS23_3D"], "description": "Bestselling Lounge marries modern style with built-to-last durability...", "highlights": ["FSCยฎ-certified hardwood from responsibly managed forests", "Benchmade frame, kiln-dried hardwood"], "dimensions": { "Overall Dimensions": "93\"W x 41\"D x 37\"H", "Inside Seat": "83\"W x 24\"D x 18\"H" }, "care": ["Do not leave spills unattended.", "Avoid direct sunlight."], "breadcrumbs": ["Furniture", "Living Room Furniture", "Sofas"] } ``` *** ### ๐Ÿ’ผ Use Cases & Examples #### 1. Price & Sale Monitoring **Retailers and resellers tracking Crate & Barrel prices and markdowns over time.** **Input:** Your product keywords and a daily schedule **Output:** Current price, regular price, and sale flags for every match **Use:** Spot price drops, react to sales, and keep your own pricing sharp. #### 2. Competitive Analysis **Furniture brands and category managers benchmarking against the Crate & Barrel assortment.** **Input:** Category keywords **Output:** Competitor prices, ratings, review counts, and sale activity **Use:** Understand where you win or lose on price, rating, and selection. #### 3. Catalog Building **E-commerce teams and marketplaces building a clean product catalog with images and dimensions.** **Input:** Keywords or category paths, in Detail mode **Output:** Titles, prices, color options, images, and full dimensions tables **Use:** Populate your storefront or PIM with structured, ready-to-use product data. #### 4. Interior Design Sourcing **Designers and stylists collecting product specs, dimensions, and imagery for client moodboards.** **Input:** Keywords for the pieces you're sourcing, in Detail mode **Output:** Dimensions, materials, color options, and high-resolution images **Use:** Build spec sheets and moodboards without manually copying each product page. #### 5. Assortment & Trend Research **Merchandisers studying which products carry the best ratings and newest arrivals.** **Input:** Category keywords, sorted by newest or top-rated **Output:** Product launches, rating trends, and review-count signals **Use:** Surface emerging products and category trends before competitors do. #### 6. MAP Compliance Monitoring **Manufacturers enforcing Minimum Advertised Price policies across Crate & Barrel listings.** **Input:** Your branded product keywords **Output:** Live listed prices and sale discounts per product **Use:** Detect MAP violations quickly and protect your brand pricing. *** ### ๐Ÿ”— Integration Examples #### JavaScript/Node.js ```javascript import { ApifyClient } from 'apify-client'; const client = new ApifyClient({ token: 'YOUR_TOKEN' }); const run = await client.actor('sian.agency/crate-and-barrel-product-scraper').call({ keywords: ['sofa'], scrapeMode: 'overview' }); const { items } = await client.dataset(run.defaultDatasetId).listItems(); console.log(items[0]); ``` #### Python ```python from apify_client import ApifyClient client = ApifyClient('YOUR_TOKEN') run = client.actor('sian.agency/crate-and-barrel-product-scraper').call( run_input={'keywords': ['sofa'], 'scrapeMode': 'overview'} ) for item in client.dataset(run['defaultDatasetId']).iterate_items(): print(item) ``` #### cURL ```bash curl -X POST 'https://api.apify.com/v2/acts/sian.agency~crate-and-barrel-product-scraper/runs?token=YOUR_TOKEN' \ -H 'Content-Type: application/json' \ -d '{"keywords": ["sofa"], "scrapeMode": "overview"}' ``` #### Automation Workflows (N8N / Zapier / Make) 1. **Trigger**: Schedule (e.g. daily) or webhook 2. **HTTP Request**: Call the actor API with your keywords 3. **Process**: Handle the JSON results 4. **Action**: Save to a sheet, sync to a database, or send a price-drop alert *** ### ๐Ÿ“Š Performance & Pricing #### FREE Tier (Try It Now) - **25 products** per run โ€” full feature access, same data quality - No credit card required - Perfect for testing and small projects #### PAID Tier (Production Ready) - **Unlimited** products per run - Run multiple searches and large categories in one go - Pay-per-result: you're only charged for the products you actually receive ๐Ÿ’ฐ **Best value on the market** โ€” transparent pay-per-result pricing with no hidden subscription fees. ๐Ÿ”— [View current pricing](https://apify.com/sian.agency/crate-and-barrel-product-scraper?fpr=sian) *** ### โ“ Frequently Asked Questions **Q: How many products can I scrape?** A: FREE tier: 25 products per run. PAID tier: unlimited products across as many searches as you like. **Q: What's the difference between Overview and Detail mode?** A: Overview is the fast path โ€” search results with price, ratings, images, and color options. Detail adds the long description, feature highlights, full dimensions table, and care instructions for every product. **Q: Can I capture product dimensions?** A: Yes โ€” run in **Detail** mode and each product includes its full structured dimensions table (overall, seat, frame, and more). **Q: What output formats are available?** A: JSON, CSV, and Excel โ€” export directly from the Apify dataset. **Q: Can I scrape by category instead of keywords?** A: Yes โ€” use the `categories` field with a Crate & Barrel category path to scrape a whole category. **Q: Can I filter results?** A: Yes โ€” use the `filters` field with on-site facets like `color`, `material`, or `type`. Every run logs the filters available for your search. **Q: Is this legal?** A: Yes โ€” we only extract publicly available product data. See the legal section below. **Q: How fresh is the data?** A: Every run pulls live data directly from Crate & Barrel at the moment you run it. Schedule runs to keep prices and sales up to date. *** ### ๐Ÿž Troubleshooting **No results returned** - Check that your keywords match real Crate & Barrel products - Try a broader search term or a different sort order **Missing dimensions or description** - Dimensions, descriptions, highlights, and care only appear in **Detail** mode โ€” switch `scrapeMode` to `detail` **A filter had no effect** - Run a search first โ€” every run logs the exact facet filters available for that search, with their valid values **Fewer results than expected on the free tier** - The FREE tier is capped at 25 products per run โ€” upgrade to PAID for unlimited results *** ### โš–๏ธ Is it legal to scrape data? Our actors are ethical and do not extract any private user data, such as email addresses, gender, or location. They only extract what is publicly shared. We therefore believe that our actors, when used for ethical purposes by Apify users, are safe. However, you should be aware that your results could contain personal data. Personal data is protected by the **GDPR** in the European Union and by other regulations around the world. You should not scrape personal data unless you have a legitimate reason to do so. If you're unsure whether your reason is legitimate, consult your lawyers. You can also read Apify's blog post on the [legality of web scraping](https://blog.apify.com/is-web-scraping-legal/). *** ### โš–๏ธ Trademark Disclaimer Crate & Barrelยฎ is a trademark of Euromarket Designs, Inc. This actor is an independent tool and is not affiliated with, endorsed by, or sponsored by Crate & Barrel. *** ### โญ Love This Tool? If this actor saves you time, please [leave us a 5-star review](https://apify.com/sian.agency/crate-and-barrel-product-scraper/reviews) โ€” it helps other professionals discover it and helps us keep improving. *** ### ๐Ÿค Support [![Telegram Support](https://img.shields.io/badge/Telegram-Support%20Group-0088cc?logo=telegram)](https://t.me/+vyh1sRE08sAxMGRi) **Join our active support community** - For issues or questions, open an issue in the actor's repository - Check the [SIรN Agency Store](https://apify.com/sian.agency?fpr=sian) for more automation tools - ๐Ÿ“ง #### More from SIรN Agency - ๐Ÿชš [Home Depot Product Scraper](https://apify.com/sian.agency/home-depot-product-scraper?fpr=sian) โ€” Home Depot prices, specs & store inventory - ๐Ÿ›๏ธ [Google Shopping Price Scraper](https://apify.com/sian.agency/google-shopping-price-scraper?fpr=sian) โ€” track offers and price history across the web - ๐Ÿช [Walmart Product Scraper](https://apify.com/sian.agency/walmart-data-scraper?fpr=sian) โ€” Walmart product and review data *** **Built by [SIรN Agency](https://www.sian-agency.online)** | **[More Tools](https://apify.com/sian.agency?fpr=sian)** # Actor input Schema ## `keywords` (type: `array`): ๐Ÿ” **KEYWORD SEARCH:** Free-text Crate & Barrel searches โ€” exactly what you'd type into the site's search bar. ๐Ÿ“ **EXAMPLES:** `sofa` ยท `dining table` ยท `area rug` ยท `bar stool` ยท `bookcase` ๐Ÿ’ก **TIP:** Add one keyword per line โ€” each runs as its own search and all results land in the same dataset. ๐Ÿ–Š๏ธ **BULK EDIT:** Click "Bulk edit" to paste many keywords at once (one per line). โœ… **IMPORTANT:** Provide either keywords OR category paths (at least one is needed to have something to scrape). ## `categories` (type: `array`): ๐Ÿงญ **CATEGORY BROWSING (Advanced):** Scrape a whole Crate & Barrel category instead of a keyword search. ๐Ÿ”ง **HOW TO GET IT:** Open any Crate & Barrel category page and copy the path after the domain (e.g. for `crateandbarrel.com/furniture/sofas/1` paste `furniture/sofas/1`). ๐Ÿ’ก **TIP:** Leave this empty if you're only using keywords โ€” it's purely an advanced alternative for category-level harvesting. ๐Ÿ–Š๏ธ **BULK EDIT:** Add one category path per line to sweep multiple categories in a single run. ## `scrapeMode` (type: `string`): โš™๏ธ **SCRAPE DEPTH:** Choose how much data to pull per product. โšก **Overview (fast):** Search results only โ€” price, ratings, images, color options and sale flags. Fastest and cheapest path (up to ~100 products per search). ๐Ÿ”ฌ **Detail (enriched):** Everything in Overview PLUS the long product description, feature highlights, the full dimensions table, care instructions and the complete image gallery scraped from each product page. ๐Ÿ’ก **TIP:** Start with Overview to scope your catalog, then switch to Detail when you need the full spec sheet for feeds or comparisons. ## `sort` (type: `string`): ๐Ÿ”ƒ **RESULT ORDERING:** Order search results using Crate & Barrel's own native sort options โ€” so you get the same ranking real shoppers see. ๐ŸŽฏ **Best match** is the site's default relevance order ยท ๐Ÿ’ฒ **Price** sorts ascending or descending ยท โญ **Top rated** leads with the highest-reviewed items ยท ๐Ÿ”ฅ **Best selling** surfaces the most popular products ยท ๐Ÿ†• **Newest** prioritizes the latest arrivals. ## `filters` (type: `array`): ๐ŸŽ›๏ธ **NARROW THE RESULTS:** Apply Crate & Barrel's own on-site filters as `key=value` entries. ๐Ÿ“ **SUPPORTED KEYS:** `type` ยท `color` ยท `material` ยท `price` ยท `width` ยท `depth` ยท `height` ยท `collection` ๐Ÿ“ **EXAMPLES:** `color=Blue` ยท `material=Leather` ยท `type=Sofas` ๐Ÿ’ก **TIP:** Run a search first โ€” every run logs the filters available for that search so you know exactly what's valid. Leave empty for no filtering. ## `maxResults` (type: `integer`): ๐Ÿ”ข **RESULT CAP:** Maximum number of products to return across all keywords and categories combined. ๐ŸŽ **TIER-BASED LIMITS:** - **FREE users:** Up to 25 products per run - **PAID users:** Unlimited โ€” scrape entire catalogs in a single run ๐Ÿ’ก **TIP:** Keep this low while you dial in your keywords, then raise it once the output looks right. ## Actor input object example ```json { "keywords": [ "sofa" ], "scrapeMode": "overview", "sort": "best_match", "maxResults": 100 } ``` # Actor output Schema ## `crateAndBarrelProducts` (type: `string`): Scraped Crate & Barrel products with prices, sale flags, ratings, images, color options, dimensions and descriptions. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "keywords": [ "sofa" ] }; // Run the Actor and wait for it to finish const run = await client.actor("sian.agency/crate-and-barrel-product-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`๐Ÿ’พ Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // ๐Ÿ“š Want to learn more ๐Ÿ“–? Go to โ†’ https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "keywords": ["sofa"] } # Run the Actor and wait for it to finish run = client.actor("sian.agency/crate-and-barrel-product-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("๐Ÿ’พ Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # ๐Ÿ“š Want to learn more ๐Ÿ“–? Go to โ†’ https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "keywords": [ "sofa" ] }' | apify call sian.agency/crate-and-barrel-product-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=sian.agency/crate-and-barrel-product-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Crate & Barrel Product Scraper", "description": "Scrape Crate & Barrel products โ€” price, ratings, images, colors, dimensions & full descriptions. Keyword or category search, detail enrichment, clean JSON/CSV, no code.", "version": "1.0", "x-build-id": "0ddsVzuUPA5LTgSMA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~crate-and-barrel-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-crate-and-barrel-product-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/sian.agency~crate-and-barrel-product-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-crate-and-barrel-product-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/sian.agency~crate-and-barrel-product-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-crate-and-barrel-product-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": { "keywords": { "title": "๐Ÿ” Search Keywords", "type": "array", "description": "๐Ÿ” **KEYWORD SEARCH:** Free-text Crate & Barrel searches โ€” exactly what you'd type into the site's search bar.\n\n๐Ÿ“ **EXAMPLES:** `sofa` ยท `dining table` ยท `area rug` ยท `bar stool` ยท `bookcase`\n\n๐Ÿ’ก **TIP:** Add one keyword per line โ€” each runs as its own search and all results land in the same dataset.\n\n๐Ÿ–Š๏ธ **BULK EDIT:** Click \"Bulk edit\" to paste many keywords at once (one per line).\n\nโœ… **IMPORTANT:** Provide either keywords OR category paths (at least one is needed to have something to scrape).", "default": [ "sofa" ], "items": { "type": "string" } }, "categories": { "title": "๐Ÿงญ Category Paths (Advanced)", "type": "array", "description": "๐Ÿงญ **CATEGORY BROWSING (Advanced):** Scrape a whole Crate & Barrel category instead of a keyword search.\n\n๐Ÿ”ง **HOW TO GET IT:** Open any Crate & Barrel category page and copy the path after the domain (e.g. for `crateandbarrel.com/furniture/sofas/1` paste `furniture/sofas/1`).\n\n๐Ÿ’ก **TIP:** Leave this empty if you're only using keywords โ€” it's purely an advanced alternative for category-level harvesting.\n\n๐Ÿ–Š๏ธ **BULK EDIT:** Add one category path per line to sweep multiple categories in a single run.", "items": { "type": "string" } }, "scrapeMode": { "title": "โš™๏ธ Scrape Mode", "enum": [ "overview", "detail" ], "type": "string", "description": "โš™๏ธ **SCRAPE DEPTH:** Choose how much data to pull per product.\n\nโšก **Overview (fast):** Search results only โ€” price, ratings, images, color options and sale flags. Fastest and cheapest path (up to ~100 products per search).\n\n๐Ÿ”ฌ **Detail (enriched):** Everything in Overview PLUS the long product description, feature highlights, the full dimensions table, care instructions and the complete image gallery scraped from each product page.\n\n๐Ÿ’ก **TIP:** Start with Overview to scope your catalog, then switch to Detail when you need the full spec sheet for feeds or comparisons.", "default": "overview" }, "sort": { "title": "๐Ÿ”ƒ Sort Order", "enum": [ "best_match", "price_low", "price_high", "rating", "best_selling", "newest" ], "type": "string", "description": "๐Ÿ”ƒ **RESULT ORDERING:** Order search results using Crate & Barrel's own native sort options โ€” so you get the same ranking real shoppers see.\n\n๐ŸŽฏ **Best match** is the site's default relevance order ยท ๐Ÿ’ฒ **Price** sorts ascending or descending ยท โญ **Top rated** leads with the highest-reviewed items ยท ๐Ÿ”ฅ **Best selling** surfaces the most popular products ยท ๐Ÿ†• **Newest** prioritizes the latest arrivals.", "default": "best_match" }, "filters": { "title": "๐ŸŽ›๏ธ Facet Filters (Advanced)", "type": "array", "description": "๐ŸŽ›๏ธ **NARROW THE RESULTS:** Apply Crate & Barrel's own on-site filters as `key=value` entries.\n\n๐Ÿ“ **SUPPORTED KEYS:** `type` ยท `color` ยท `material` ยท `price` ยท `width` ยท `depth` ยท `height` ยท `collection`\n\n๐Ÿ“ **EXAMPLES:** `color=Blue` ยท `material=Leather` ยท `type=Sofas`\n\n๐Ÿ’ก **TIP:** Run a search first โ€” every run logs the filters available for that search so you know exactly what's valid. Leave empty for no filtering.", "items": { "type": "string" } }, "maxResults": { "title": "๐Ÿ”ข Max Results", "minimum": 1, "type": "integer", "description": "๐Ÿ”ข **RESULT CAP:** Maximum number of products to return across all keywords and categories combined.\n\n๐ŸŽ **TIER-BASED LIMITS:**\n- **FREE users:** Up to 25 products per run\n- **PAID users:** Unlimited โ€” scrape entire catalogs in a single run\n\n๐Ÿ’ก **TIP:** Keep this low while you dial in your keywords, then raise it once the output looks right.", "default": 100 } } }, "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 } } } } } } } } } } ```