{ "openapi": "3.0.1", "info": { "title": "Shopify Store Leads Scraper — Detect, Extract, Enrich", "description": "Detect Shopify stores, extract full product catalogue, identify installed apps & theme, pull contact leads (email, phone, socials, legal business name), estimate plan tier. Works on native Shopify and headless storefronts.", "version": "0.1", "x-build-id": "0itE3GbMEa5cMXpGq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/buff_pineapple~shopify-store-leads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-buff_pineapple-shopify-store-leads-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/buff_pineapple~shopify-store-leads-scraper/runs": { "post": { "operationId": "runs-sync-buff_pineapple-shopify-store-leads-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/buff_pineapple~shopify-store-leads-scraper/run-sync": { "post": { "operationId": "run-sync-buff_pineapple-shopify-store-leads-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 URLs", "type": "array", "description": "List of store URLs or bare domains to analyze (e.g. https://www.allbirds.com, fashionnova.com).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "mode": { "title": "Run mode", "enum": [ "fingerprint", "products", "collections", "leads", "full" ], "type": "string", "description": "What to extract: fingerprint (detection + summary), products (full catalogue), collections (taxonomy), leads (contacts only), or full (everything per store + all products).", "default": "fingerprint" }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cap on how many products to pull per store in products/full mode. 0 = no cap.", "default": 250 }, "minPrice": { "title": "Filter: min price", "minimum": 0, "type": "integer", "description": "Only return products at or above this price (in store currency).", "default": 0 }, "maxPrice": { "title": "Filter: max price", "minimum": 0, "type": "integer", "description": "Only return products at or below this price. 0 = no cap.", "default": 0 }, "onlyAvailable": { "title": "Filter: only in-stock variants", "type": "boolean", "description": "Drop products where no variant is currently available.", "default": false }, "onlyOnSale": { "title": "Filter: only items on sale (compare_at_price > price)", "type": "boolean", "description": "Drop products that are not on sale (no compare-at price set above the current price).", "default": false }, "createdSinceDays": { "title": "Filter: new products in the last N days", "minimum": 0, "type": "integer", "description": "0 = no filter.", "default": 0 }, "vendorFilter": { "title": "Filter: vendor names", "type": "array", "description": "Only return products from these vendors (case-insensitive).", "default": [], "items": { "type": "string" } }, "productTypeFilter": { "title": "Filter: product types", "type": "array", "description": "Only return products with one of these product_type values.", "default": [], "items": { "type": "string" } }, "collectionHandles": { "title": "Collection handles to scope to (modes: products, full)", "type": "array", "description": "If set, fetch products from /collections//products.json instead of /products.json. Empty = all products.", "default": [], "items": { "type": "string" } }, "includeAppDetection": { "title": "Detect installed apps & tech stack", "type": "boolean", "description": "Inspect homepage for Klaviyo, Judge.me, Loox, Gorgias, Recharge, Yotpo, Tapcart, Bold, etc.", "default": true }, "appsFilter": { "title": "Filter: stores with these apps installed", "type": "array", "description": "If set, only emit stores that have AT LEAST ONE of these apps installed (e.g. klaviyo, recharge, judge_me).", "default": [], "items": { "type": "string" } }, "includeLeads": { "title": "Extract contact info (emails, phones, socials)", "type": "boolean", "description": "Parse homepage + contact/about pages + JSON-LD for emails, phones, social profiles. Adds 1-2 HTTP requests per store.", "default": true }, "includePolicies": { "title": "Pull business legal name from privacy policy", "type": "boolean", "description": "Fetch /policies/privacy-policy and parse for the registered legal business name. Helpful for B2B outbound personalisation.", "default": true }, "respectRobots": { "title": "Respect robots.txt", "type": "boolean", "description": "If false, the actor will still hit Shopify's public JSON endpoints even when robots.txt disallows them. Default is to respect.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Apify proxy recommended for residential IPs on rate-limited stores." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 100, "type": "integer", "description": "Max number of stores processed in parallel. Higher = faster but more memory and likely more proxy usage.", "default": 10 } } }, "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 } } } } } } } } } }