# Yarnspirations Yarn & Pattern Catalog Scraper (`jungle_synthesizer/yarnspirations-yarn-pattern-catalog-scraper`) Actor Scrapes the complete Yarnspirations product catalog via the Shopify storefront API. Covers Red Heart, Bernat, Caron, Patons, and Lily Sugar'n Cream — yarns, free patterns, and tools. Returns product type, brand, price, availability, SKU, craft type, and image URLs. No authentication required. - **URL**: https://apify.com/jungle\_synthesizer/yarnspirations-yarn-pattern-catalog-scraper.md - **Developed by:** [BowTiedRaccoon](https://apify.com/jungle_synthesizer) (community) - **Categories:** E-commerce, For creators - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per event This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. 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 ## Yarnspirations Yarn & Pattern Catalog Scraper Scrapes the complete Yarnspirations product catalog — yarns, free patterns, and tools — from the public Shopify storefront API. Covers all five major brands: **Red Heart**, **Bernat**, **Caron**, **Patons**, and **Lily Sugar'n Cream**. No authentication required. Returns structured product data including type, brand, price, availability, SKU, craft type, and direct image and product page URLs. ### What you get Each record in the output dataset includes: | Field | Description | |-------|-------------| | `product_id` | Shopify product ID | | `title` | Product title | | `handle` | URL-friendly product slug | | `product_type` | Yarn, Pattern, Tool, Bundle, etc. | | `brand` | Brand name (Red Heart, Bernat, Caron, Patons, Lily Sugar'n Cream) | | `vendor` | Vendor name (same as brand on Yarnspirations) | | `tags` | Shopify product tags array | | `price_usd` | Price in USD (0 for free patterns) | | `available` | Whether any variant is currently in stock | | `sku` | Primary variant SKU | | `is_free_pattern` | True when the product is a free downloadable pattern | | `craft_type` | knit or crochet (parsed from tags) | | `image_url` | Primary product image URL | | `product_url` | Full URL to the product page | > **Note on spec fields:** `fiber_content`, `yarn_weight`, `yardage`, `gauge`, `needle_hook_size`, `care_instructions`, and `skill_level` are rendered from Shopify metafields on individual product pages and are not available in the storefront API. These fields are returned as empty strings. ### How it works The actor paginates through `https://www.yarnspirations.com/products.json?limit=250&page=N`, retrieving up to 250 products per page. It stops automatically when the API returns an empty page. The full catalog contains approximately 12,000–13,000 products across 52 pages. No proxy is required. The Shopify storefront API is publicly accessible with no authentication, geo-restrictions, or rate-limit enforcement beyond the ~2 requests/second safe limit (the actor uses a 600ms delay between pages). ### Input | Parameter | Type | Default | Description | |-----------|------|---------|-------------| | `maxItems` | integer | 15 | Maximum number of products to scrape. Leave empty or set to a high number to scrape the full catalog. | **Example input** to scrape the full catalog: ```json { "maxItems": 20000 } ```` **Example input** to scrape a sample of 50 products: ```json { "maxItems": 50 } ``` ### Use cases - **Price tracking** — Monitor yarn prices across all Yarnspirations brands - **Catalog synchronization** — Keep an up-to-date inventory of available products - **Pattern catalog** — Extract all free patterns by craft type (knit vs crochet) - **Brand analysis** — Compare product counts and availability across Red Heart, Bernat, Caron, Patons, and Lily Sugar'n Cream - **Craft supply reseller data** — Structured catalog for resellers or price comparison tools ### Coverage The actor covers the entire `yarnspirations.com` product catalog, which includes products from the Yarnspirations family of brands operated by Spinrite Inc.: - **Red Heart** — America's best-known yarn brand - **Bernat** — Blanket, baby, and specialty yarns - **Caron** — Fashion and everyday yarns - **Patons** — Premium knitting and crochet yarns - **Lily Sugar'n Cream** — Cotton kitchen and craft yarns ### Performance A full catalog run (~12,500 products, 52 pages) completes in approximately 35–40 seconds at the default 600ms page delay. Memory usage stays well under 256 MB. # Actor input Schema ## `sp_intended_usage` (type: `string`): Please describe how you plan to use the data extracted by this crawler. ## `sp_improvement_suggestions` (type: `string`): Provide any feedback or suggestions for improvements. ## `sp_contact` (type: `string`): Provide your email address so we can get in touch with you. ## `maxItems` (type: `integer`): Maximum number of products to scrape. Leave empty to scrape the full catalog (~12,000+ products). ## Actor input object example ```json { "sp_intended_usage": "Describe your intended use...", "sp_improvement_suggestions": "Share your suggestions here...", "sp_contact": "Share your email here...", "maxItems": 15 } ``` # Actor output Schema ## `results` (type: `string`): No description # 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 = { "sp_intended_usage": "Describe your intended use...", "sp_improvement_suggestions": "Share your suggestions here...", "sp_contact": "Share your email here...", "maxItems": 15 }; // Run the Actor and wait for it to finish const run = await client.actor("jungle_synthesizer/yarnspirations-yarn-pattern-catalog-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 = { "sp_intended_usage": "Describe your intended use...", "sp_improvement_suggestions": "Share your suggestions here...", "sp_contact": "Share your email here...", "maxItems": 15, } # Run the Actor and wait for it to finish run = client.actor("jungle_synthesizer/yarnspirations-yarn-pattern-catalog-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 '{ "sp_intended_usage": "Describe your intended use...", "sp_improvement_suggestions": "Share your suggestions here...", "sp_contact": "Share your email here...", "maxItems": 15 }' | apify call jungle_synthesizer/yarnspirations-yarn-pattern-catalog-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=jungle_synthesizer/yarnspirations-yarn-pattern-catalog-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Yarnspirations Yarn & Pattern Catalog Scraper", "description": "Scrapes the complete Yarnspirations product catalog via the Shopify storefront API. Covers Red Heart, Bernat, Caron, Patons, and Lily Sugar'n Cream — yarns, free patterns, and tools. Returns product type, brand, price, availability, SKU, craft type, and image URLs. No authentication required.", "version": "0.1", "x-build-id": "wIQoKG2thGKyiqWzg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jungle_synthesizer~yarnspirations-yarn-pattern-catalog-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jungle_synthesizer-yarnspirations-yarn-pattern-catalog-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/jungle_synthesizer~yarnspirations-yarn-pattern-catalog-scraper/runs": { "post": { "operationId": "runs-sync-jungle_synthesizer-yarnspirations-yarn-pattern-catalog-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/jungle_synthesizer~yarnspirations-yarn-pattern-catalog-scraper/run-sync": { "post": { "operationId": "run-sync-jungle_synthesizer-yarnspirations-yarn-pattern-catalog-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": [ "maxItems" ], "properties": { "sp_intended_usage": { "title": "What is the intended usage of this data?", "minLength": 1, "type": "string", "description": "Please describe how you plan to use the data extracted by this crawler." }, "sp_improvement_suggestions": { "title": "How can we improve this crawler for you?", "minLength": 1, "type": "string", "description": "Provide any feedback or suggestions for improvements." }, "sp_contact": { "title": "Contact Email", "minLength": 1, "type": "string", "description": "Provide your email address so we can get in touch with you." }, "maxItems": { "title": "Max Items", "type": "integer", "description": "Maximum number of products to scrape. Leave empty to scrape the full catalog (~12,000+ products).", "default": 15 } } }, "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 } } } } } } } } } } ```