# Shopify Scraper (GraphQL) (`runexes/actor-shopify-scraper`) Actor An Apify actor that crawls Shopify stores via `sitemap.xml` and fetches product data using the Storefront GraphQL API. Optimized for speed and cost with per-host batching, incremental processing, and buffered dataset writes. - **URL**: https://apify.com/runexes/actor-shopify-scraper.md - **Developed by:** [Alex](https://apify.com/runexes) (community) - **Categories:** E-commerce, Automation, Open source - **Stats:** 15 total users, 1 monthly users, 100.0% runs succeeded, 0 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 (GraphQL) An Apify actor that crawls Shopify stores via `sitemap.xml` and fetches product data using the Storefront GraphQL API. Optimized for speed and cost with per-host batching, incremental processing, and buffered dataset writes. #### Features - Reads `sitemap.xml`, filters product URLs (`/products/`) - Batches GraphQL requests per store using aliases (fewer round-trips) - Optional incremental runs (skips already processed product IDs) - Optional lastmod cutoff to skip old products - Outputs a single record per product; all variants are available under `additional.variants` - Extensible via `extendScraperFunction` and `extendOutputFunction` #### Input parameters (core) - `startUrls`: array of `sitemap.xml` URLs - `storefrontApiVersion`: Storefront API version (e.g., `2024-07`) - `storefrontAccessToken`: your Storefront access token - `maxRequestsPerCrawl`, `maxConcurrency`, `maxRequestRetries`, `proxyConfig`, `debugLog` #### Performance inputs - `updatedSince`: ISO date; skips products with `` older than this - `batchSize`: product handles per GraphQL request (default 10) - `flushIntervalMs`: max delay before sending a partial batch (default 300) - `perHostConcurrency`: parallel GraphQL requests per store (default 2) - `bufferWrites`: buffer dataset writes (default true) - `bufferSize`: items per dataset push (default 100) #### Run locally 1) Install dependencies: ```bash npm install ```` 2. Create local input at `apify_storage/key_value_stores/default/INPUT.json`, for example: ```json { "startUrls": [{ "url": "https://example.com/sitemap.xml" }], "storefrontApiVersion": "2024-07", "storefrontAccessToken": "", "maxRequestsPerCrawl": 50, "maxConcurrency": 10, "debugLog": true } ``` 3. Start the actor: ```bash npm start ``` Or development mode with auto-restart: ```bash npm run dev ``` #### GitHub integration Workflows in `.github/workflows/`: - `ci.yml`: install, lint, and syntax check on push/PR to `main`. - `codeql.yml`: CodeQL security analysis on push/PR and weekly. #### Docker quick start ```bash make init # creates .env and INPUT.json from templates make run # docker compose up --build actor ``` Outputs will be in `apify_storage/datasets/default`. #### Extensibility - `extendScraperFunction`: lifecycle hooks (`SETUP`, `FILTER_SITEMAP_URL`, `PRENAVIGATION`, `POSTNAVIGATION`, `RUN`, `FINISHED`) - `extendOutputFunction`: transform/filter final records before they are saved to the Dataset #### License This project is licensed under the Apache License 2.0. See `LICENSE` and `NOTICE`. # Actor input Schema ## `startUrls` (type: `array`): Provide sitemap.xml URLs as the starting point ## `maxRequestsPerCrawl` (type: `integer`): Maximum number of items to scrape. Set it to 0 to scrape everything. ## `proxyConfig` (type: `object`): Use either automatic Apify proxies, Residentials or your own. ## `extendOutputFunction` (type: `string`): Add or remove properties on the output object or omit the output returning null ## `extendScraperFunction` (type: `string`): Advanced function that allows you to extend the default scraper functionality, allowing you to manually perform actions on the page ## `customData` (type: `object`): Any data that you want to have available inside the Extend Output/Scraper Function ## `maxConcurrency` (type: `integer`): Max concurrency to use ## `maxRequestRetries` (type: `integer`): Set the max request retries ## `updatedSince` (type: `string`): Skip products older than this date based on sitemap . ## `batchSize` (type: `integer`): Number of product handles to fetch per GraphQL request (per store) ## `flushIntervalMs` (type: `integer`): Maximum time to wait before sending a partial batch ## `perHostConcurrency` (type: `integer`): Parallel GraphQL requests per store ## `bufferWrites` (type: `boolean`): Accumulate items in memory and push in batches ## `bufferSize` (type: `integer`): Number of items to accumulate before pushing ## `storefrontApiVersion` (type: `string`): Version of Shopify Storefront API (e.g. 2024-07) ## `storefrontShopDomain` (type: `string`): Full origin for Storefront API calls, e.g. https://your-shop.myshopify.com. If empty, the scraper will use the product site origin. ## `storefrontAccessToken` (type: `string`): Shopify Storefront API access token ## `debugLog` (type: `boolean`): Enable a more verbose logging to be able to understand what's happening during the scraping ## Actor input object example ```json { "startUrls": [ { "url": "https://www.decathlon.com/sitemap.xml" } ], "maxRequestsPerCrawl": 10, "proxyConfig": { "useApifyProxy": true }, "extendOutputFunction": "async ({ data, item, product, images, fns, name, request, variants, context, customData, input, Apify }) => {\n return item;\n}", "extendScraperFunction": "async ({ fns, customData, Apify, label }) => {\n \n}", "customData": {}, "maxConcurrency": 10, "maxRequestRetries": 3, "updatedSince": "", "batchSize": 10, "flushIntervalMs": 300, "perHostConcurrency": 2, "bufferWrites": true, "bufferSize": 100, "storefrontApiVersion": "2024-07", "storefrontShopDomain": "", "storefrontAccessToken": "", "debugLog": false } ``` # 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": [ { "url": "https://www.decathlon.com/sitemap.xml" } ], "maxRequestsPerCrawl": 10, "proxyConfig": { "useApifyProxy": true }, "extendOutputFunction": async ({ data, item, product, images, fns, name, request, variants, context, customData, input, Apify }) => { return item; }, "extendScraperFunction": async ({ fns, customData, Apify, label }) => { }, "customData": {}, "maxConcurrency": 10, "maxRequestRetries": 3, "updatedSince": "", "batchSize": 10, "flushIntervalMs": 300, "perHostConcurrency": 2, "bufferSize": 100, "storefrontApiVersion": "2024-07", "storefrontShopDomain": "", "storefrontAccessToken": "" }; // Run the Actor and wait for it to finish const run = await client.actor("runexes/actor-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": [{ "url": "https://www.decathlon.com/sitemap.xml" }], "maxRequestsPerCrawl": 10, "proxyConfig": { "useApifyProxy": True }, "extendOutputFunction": """async ({ data, item, product, images, fns, name, request, variants, context, customData, input, Apify }) => { return item; }""", "extendScraperFunction": """async ({ fns, customData, Apify, label }) => { }""", "customData": {}, "maxConcurrency": 10, "maxRequestRetries": 3, "updatedSince": "", "batchSize": 10, "flushIntervalMs": 300, "perHostConcurrency": 2, "bufferSize": 100, "storefrontApiVersion": "2024-07", "storefrontShopDomain": "", "storefrontAccessToken": "", } # Run the Actor and wait for it to finish run = client.actor("runexes/actor-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": [ { "url": "https://www.decathlon.com/sitemap.xml" } ], "maxRequestsPerCrawl": 10, "proxyConfig": { "useApifyProxy": true }, "extendOutputFunction": "async ({ data, item, product, images, fns, name, request, variants, context, customData, input, Apify }) => {\\n return item;\\n}", "extendScraperFunction": "async ({ fns, customData, Apify, label }) => {\\n \\n}", "customData": {}, "maxConcurrency": 10, "maxRequestRetries": 3, "updatedSince": "", "batchSize": 10, "flushIntervalMs": 300, "perHostConcurrency": 2, "bufferSize": 100, "storefrontApiVersion": "2024-07", "storefrontShopDomain": "", "storefrontAccessToken": "" }' | apify call runexes/actor-shopify-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=runexes/actor-shopify-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Shopify Scraper (GraphQL)", "description": "An Apify actor that crawls Shopify stores via `sitemap.xml` and fetches product data using the Storefront GraphQL API. Optimized for speed and cost with per-host batching, incremental processing, and buffered dataset writes.", "version": "0.0", "x-build-id": "5xO0cwEorwXbj4QdI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/runexes~actor-shopify-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-runexes-actor-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/runexes~actor-shopify-scraper/runs": { "post": { "operationId": "runs-sync-runexes-actor-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/runexes~actor-shopify-scraper/run-sync": { "post": { "operationId": "run-sync-runexes-actor-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": [ "storefrontAccessToken" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Provide sitemap.xml URLs as the starting point", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxRequestsPerCrawl": { "title": "Max items", "type": "integer", "description": "Maximum number of items to scrape. Set it to 0 to scrape everything.", "default": 10 }, "proxyConfig": { "title": "Proxy Configuration", "type": "object", "description": "Use either automatic Apify proxies, Residentials or your own.", "default": { "useApifyProxy": true } }, "extendOutputFunction": { "title": "Extend Output Function", "type": "string", "description": "Add or remove properties on the output object or omit the output returning null", "default": "async ({ data, item, product, images, fns, name, request, variants, context, customData, input, Apify }) => {\n return item;\n}" }, "extendScraperFunction": { "title": "Extend Scraper Function", "type": "string", "description": "Advanced function that allows you to extend the default scraper functionality, allowing you to manually perform actions on the page", "default": "async ({ fns, customData, Apify, label }) => {\n \n}" }, "customData": { "title": "Custom data", "type": "object", "description": "Any data that you want to have available inside the Extend Output/Scraper Function", "default": {} }, "maxConcurrency": { "title": "Max concurrency", "type": "integer", "description": "Max concurrency to use", "default": 10 }, "maxRequestRetries": { "title": "Max request retries", "type": "integer", "description": "Set the max request retries", "default": 3 }, "updatedSince": { "title": "Updated since (ISO date)", "type": "string", "description": "Skip products older than this date based on sitemap .", "default": "" }, "batchSize": { "title": "GraphQL batch size", "type": "integer", "description": "Number of product handles to fetch per GraphQL request (per store)", "default": 10 }, "flushIntervalMs": { "title": "Batch flush interval (ms)", "type": "integer", "description": "Maximum time to wait before sending a partial batch", "default": 300 }, "perHostConcurrency": { "title": "Per-host concurrency", "type": "integer", "description": "Parallel GraphQL requests per store", "default": 2 }, "bufferWrites": { "title": "Buffer dataset writes", "type": "boolean", "description": "Accumulate items in memory and push in batches", "default": true }, "bufferSize": { "title": "Dataset buffer size", "type": "integer", "description": "Number of items to accumulate before pushing", "default": 100 }, "storefrontApiVersion": { "title": "Storefront API version", "type": "string", "description": "Version of Shopify Storefront API (e.g. 2024-07)", "default": "2024-07" }, "storefrontShopDomain": { "title": "Shopify shop domain for Storefront API", "type": "string", "description": "Full origin for Storefront API calls, e.g. https://your-shop.myshopify.com. If empty, the scraper will use the product site origin.", "default": "" }, "storefrontAccessToken": { "title": "Storefront access token", "type": "string", "description": "Shopify Storefront API access token", "default": "" }, "debugLog": { "title": "Debug Log", "type": "boolean", "description": "Enable a more verbose logging to be able to understand what's happening during the scraping", "default": false } } }, "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 } } } } } } } } } } ```