{ "openapi": "3.0.1", "info": { "title": "Shopify Store Scraper — Emails, Phones & Apps", "description": "Find Shopify stores by niche, keyword, country or direct URL. Get store identity, product counts, public emails, phone numbers, social profiles, Shopify themes and installed apps. Results stream live and can be sent to any webhook. Free Apify accounts are limited to 2 results per run.", "version": "0.0", "x-build-id": "LVcCbnydKqXrqBvcN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~Shopify-Real-Time-Data-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-Shopify-Real-Time-Data-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/b2b_leads~Shopify-Real-Time-Data-Scraper/runs": { "post": { "operationId": "runs-sync-b2b_leads-Shopify-Real-Time-Data-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/b2b_leads~Shopify-Real-Time-Data-Scraper/run-sync": { "post": { "operationId": "run-sync-b2b_leads-Shopify-Real-Time-Data-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", "properties": { "enableDirectoryBrowse": { "title": "Directory & niche search", "type": "boolean", "description": "Discover stores by niche from the merchant directory. Enabled by default.", "default": true }, "searchTasks": { "title": "Search tasks", "type": "array", "description": "Define niches, keywords, or countries to discover. Multiple tasks run concurrently.", "items": { "type": "object", "properties": { "niche": { "title": "Niche / Category", "type": "string", "description": "Store niche (e.g. clothing, jewelry, skincare, pet, coffee, sneakers).", "editor": "textfield" }, "keyword": { "title": "Keyword", "type": "string", "description": "Optional search keyword or brand term.", "editor": "textfield" }, "country": { "title": "Country filter", "type": "string", "description": "2-letter country code or country name (e.g. US, UK, CA, AU).", "editor": "textfield" }, "maxResults": { "title": "Max stores for task", "type": "integer", "description": "How many stores to collect for this task. The run's total is the sum of this value across every task you add. Free accounts are limited to 2 results per run.", "minimum": 1, "editor": "number" } } } }, "enableKeywordSearch": { "title": "Enable keyword discovery", "type": "boolean", "description": "Enable full-text multi-keyword discovery across merchant niches.", "default": false }, "keywords": { "title": "Keywords list (optional)", "type": "array", "description": "Keywords to search across store directories.", "items": { "type": "string" } }, "enableStoreDetails": { "title": "Direct store URL lookup", "type": "boolean", "description": "Enrich specific store domains or URLs directly without niche searching.", "default": false }, "storeUrls": { "title": "Store URLs", "type": "array", "description": "List of Shopify store website URLs to enrich (e.g. https://gymshark.com).", "items": { "type": "string" } }, "enableLeadDetails": { "title": "Enable lead details", "type": "boolean", "description": "Enrich stores with verified contact emails, phone numbers, and social media handles. Every merchant is still exported even if some contacts are missing. Adds a little extra time per business.", "default": true }, "enrichThemeApps": { "title": "Enrich Shopify theme & installed apps", "type": "boolean", "description": "Detect active Shopify theme name and list of installed Shopify apps for each store.", "default": false }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. Every record is always saved to the run's dataset — this webhook is an additional real-time push. When set, each new record is also POSTed to this URL (CRM, Slack incoming webhook, Zapier, Make, Google Sheets).", "default": "" }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "json = full store record object; slack = Slack-formatted message block.", "default": "json" }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Apify residential proxy (US) is enabled by default for reliable store and directory collection.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }