{ "openapi": "3.0.1", "info": { "title": "Shopify Store Leads Scraper", "description": "Find contactable Shopify store leads with public business emails, socials, product samples, marketing tech signals, and outreach scores.", "version": "0.1", "x-build-id": "pBOEukJqseMAc5BU1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wishful_knowledge~shopify-lead-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wishful_knowledge-shopify-lead-finder", "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/wishful_knowledge~shopify-lead-finder/runs": { "post": { "operationId": "runs-sync-wishful_knowledge-shopify-lead-finder", "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/wishful_knowledge~shopify-lead-finder/run-sync": { "post": { "operationId": "run-sync-wishful_knowledge-shopify-lead-finder", "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": { "queries": { "title": "Niche search queries", "type": "array", "description": "Search terms used to discover candidate Shopify stores. Add a niche, country, or product category.", "items": { "type": "string" } }, "startUrls": { "title": "Seed store URLs", "type": "array", "description": "Known Shopify or ecommerce store URLs to analyze directly. Use this if you already have a prospect list.", "items": { "type": "string" } }, "includeSearchDiscovery": { "title": "Discover URLs from search", "type": "boolean", "description": "When enabled, the Actor uses HTML search pages to find candidate stores from the search queries. This is best-effort and can be throttled by search engines.", "default": false }, "includeCommonCrawlDiscovery": { "title": "Discover myshopify.com stores from Common Crawl", "type": "boolean", "description": "When enabled, the Actor discovers public myshopify.com subdomains from the latest Common Crawl indexes.", "default": false }, "commonCrawlLimit": { "title": "Common Crawl candidate limit", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum myshopify.com candidate URLs to collect from Common Crawl before analysis.", "default": 25 }, "includePhones": { "title": "Include public phone and WhatsApp numbers", "type": "boolean", "description": "When enabled, extracts public phone and WhatsApp numbers shown on store pages. Disabled by default to reduce privacy risk.", "default": false }, "includePersonalEmails": { "title": "Include individual-looking emails", "type": "boolean", "description": "When disabled, keeps only generic business role emails such as info@, support@, sales@, and hello@.", "default": false }, "requireBusinessEmail": { "title": "Require business email for saved leads", "type": "boolean", "description": "When enabled, only leads with at least one public business role email are saved to the dataset. This keeps paid-per-event outputs focused on contactable prospects.", "default": true }, "includeProductSamples": { "title": "Include sample product titles", "type": "boolean", "description": "When enabled, includes a small sample of public product titles from Shopify JSON endpoints.", "default": true }, "productSampleLimit": { "title": "Product sample limit", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum public product titles to include per store. Lower values reduce output size and copyright exposure.", "default": 5 }, "minOpportunityScore": { "title": "Minimum opportunity score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only records with this score or higher are saved to the dataset. Lower-scoring confirmed stores are counted in RUN_SUMMARY but filtered out to protect paid-per-result economics.", "default": 50 }, "maxStores": { "title": "Max stores", "minimum": 1, "maximum": 250, "type": "integer", "description": "Maximum number of unique store domains to analyze.", "default": 25 }, "maxSearchResultsPerQuery": { "title": "Max search results per query", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum candidate URLs to collect from each query.", "default": 10 }, "maxPagesPerStore": { "title": "Max pages per store", "minimum": 1, "maximum": 12, "type": "integer", "description": "Maximum public pages to fetch from each store, including homepage, contact/about pages, and Shopify JSON endpoints.", "default": 4 }, "requestDelayMs": { "title": "Request delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between requests, in milliseconds.", "default": 750 }, "timeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 60, "type": "integer", "description": "Timeout for each HTTP request.", "default": 15 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skips paths disallowed for generic crawlers by robots.txt when enabled.", "default": true }, "userAgent": { "title": "User agent", "type": "string", "description": "HTTP User-Agent header used for requests.", "default": "Mozilla/5.0 (compatible; ShopifyStoreLeadsScraper/0.1; +https://apify.com/)" } } }, "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 } } } } } } } } } }