# Shopify Scraper (`scrapebase/shopify-scraper`) Actor - **URL**: https://apify.com/scrapebase/shopify-scraper.md - **Developed by:** [ScrapeBase](https://apify.com/scrapebase) (community) - **Categories:** Automation, Lead generation, E-commerce - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## 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 ## Shopify Scraper Scrapes product data from Shopify stores: homepage, collection pages, or direct product URLs. Output matches a single JSON object with `scraped_at`, `config`, `total_products`, and `products` array. ### Why use this actor - **Bulk URLs**: Pass multiple store/collection/product URLs in one run. - **Proxy fallback**: Uses no proxy by default; if blocked, falls back to datacenter then residential (with 3 retries), and sticks with residential for the rest of the run. - **Structured output**: Each product includes source, title, description, brand, categories, tags, variants, medias, and options. ### Input | Field | Type | Required | Description | |-------|------|----------|-------------| | **startUrls** | array | Yes | Shopify store homepages, collection URLs, or product URLs. | | **maxResults** | integer | No | Max products per URL (default: 100, 0 = no limit). | | **proxyConfiguration** | object | No | Apify proxy settings; used for datacenter/residential fallback when needed. | Example: ```json { "startUrls": [ { "url": "https://kith.com/" }, { "url": "https://store.com/collections/shoes" } ], "maxResults": 100, "proxyConfiguration": { "useApifyProxy": true } } ```` ### Output One dataset item with: - **scraped\_at** – UTC timestamp of the run. - **config** – Echo of startUrls, maxResults, etc. - **total\_products** – Total number of products scraped. - **products** – Array of product objects: `source`, `title`, `description`, `brand`, `categories`, `tags`, `variants`, `medias`, `options`. ### How to use (Apify Console) 1. Open [Apify Console](https://console.apify.com) → **Actors**. 2. Select **Shopify Scraper**. 3. Set **Start URLs** and optionally **Max results** and **Proxy configuration**. 4. Click **Start**. 5. Check the **Log** for progress and proxy fallback messages. 6. Download or view the result in the run **Dataset** (single item with `products` array). ### Cautions - Data is collected from publicly available Shopify storefronts only. - You are responsible for compliance with the target site’s terms and applicable laws (e.g. privacy, data protection). # Actor input Schema ## `startUrls` (type: `array`): Paste Shopify store URLs, one per line. Examples: • Store homepage: https://store.com/ • Collection: https://store.com/collections/shoes • Single product: https://store.com/products/blue-sneakers ## `query` (type: `string`): Optional search or filter term. Stored in the output config for your reference. ## `maxResults` (type: `integer`): Maximum products to scrape per start URL. Set to 0 for no limit. ## `maxRecommendationsPerProduct` (type: `integer`): How many related/recommended products to include per product (0–20). Set 0 to disable. ## `proxyConfiguration` (type: `object`): Leave empty to start with no proxy. If a store blocks you, the actor will try datacenter then residential proxy automatically. ## Actor input object example ```json { "startUrls": [ "https://boat-lifestyle.com" ], "query": "", "maxResults": 100, "maxRecommendationsPerProduct": 0 } ``` # 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 = { "startUrls": [ "https://boat-lifestyle.com" ] }; // Run the Actor and wait for it to finish const run = await client.actor("scrapebase/shopify-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 = { "startUrls": ["https://boat-lifestyle.com"] } # Run the Actor and wait for it to finish run = client.actor("scrapebase/shopify-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 '{ "startUrls": [ "https://boat-lifestyle.com" ] }' | apify call scrapebase/shopify-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=scrapebase/shopify-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Shopify Scraper", "version": "0.1", "x-build-id": "6XxGxjpsqMf9EkLei" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapebase~shopify-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapebase-shopify-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/scrapebase~shopify-scraper/runs": { "post": { "operationId": "runs-sync-scrapebase-shopify-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/scrapebase~shopify-scraper/run-sync": { "post": { "operationId": "run-sync-scrapebase-shopify-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": [ "startUrls" ], "properties": { "startUrls": { "title": "🔗 Store or product URLs", "type": "array", "description": "Paste Shopify store URLs, one per line. Examples:\n• Store homepage: https://store.com/\n• Collection: https://store.com/collections/shoes\n• Single product: https://store.com/products/blue-sneakers", "items": { "type": "string" } }, "query": { "title": "🔍 Search query (optional)", "type": "string", "description": "Optional search or filter term. Stored in the output config for your reference.", "default": "" }, "maxResults": { "title": "📦 Max products per URL", "minimum": 0, "type": "integer", "description": "Maximum products to scrape per start URL. Set to 0 for no limit.", "default": 100 }, "maxRecommendationsPerProduct": { "title": "✨ Max recommendations per product", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many related/recommended products to include per product (0–20). Set 0 to disable.", "default": 0 }, "proxyConfiguration": { "title": "🌐 Proxy (optional)", "type": "object", "description": "Leave empty to start with no proxy. If a store blocks you, the actor will try datacenter then residential proxy automatically." } } }, "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 } } } } } } } } } } ```