{ "openapi": "3.0.1", "info": { "title": "Shopify Store Leads Scraper", "description": "Find Shopify store leads by keyword or category — websites, contacts, ratings, and sample products.", "version": "0.0", "x-build-id": "VzMb3Bb0Xkc6nRQXO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/powerai~shopify-store-leads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-powerai-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/powerai~shopify-store-leads-scraper/runs": { "post": { "operationId": "runs-sync-powerai-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/powerai~shopify-store-leads-scraper/run-sync": { "post": { "operationId": "run-sync-powerai-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", "properties": { "query": { "title": "Search query", "type": "string", "description": "Product keyword to discover stores (e.g. organic coffee, yoga mat). Leave empty when browsing by category only." }, "category": { "title": "Category", "enum": [ "", "gid://shopify/ProductCategory/1", "gid://shopify/ProductCategory/2", "gid://shopify/ProductCategory/3", "gid://shopify/ProductCategory/5", "gid://shopify/ProductCategory/6", "gid://shopify/ProductCategory/7", "gid://shopify/ProductCategory/9", "gid://shopify/ProductCategory/10", "gid://shopify/ProductCategory/15", "gid://shopify/ProductCategory/69", "gid://shopify/ProductCategory/209", "gid://shopify/ProductCategory/251", "gid://shopify/ProductCategory/267", "gid://shopify/ProductCategory/285" ], "type": "string", "description": "Optional Shopify product category. Used as a search hint; taxonomy filters are best-effort." }, "storeLocation": { "title": "Store location / market", "enum": [ "", "US", "GB", "CA", "AU", "NZ", "IE", "DE", "FR", "IT", "ES", "NL", "PL", "AT", "CH", "PT", "SE", "DK", "FI", "ENGLISH_SPEAKING", "EUROPE", "NORTH_AMERICA", "UK_IRELAND", "NORDICS", "OCEANIA", "GLOBAL" ], "type": "string", "description": "Country code (US, GB, …) or region (NORTH_AMERICA, EUROPE, GLOBAL, …). Affects localization and shipping filters." }, "maxItems": { "title": "Max stores", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of unique store leads to return (1–10000).", "default": 50 }, "priceMin": { "title": "Min product price", "type": "number", "description": "Only include catalog hits with price at or above this amount (major currency units)." }, "priceMax": { "title": "Max product price", "type": "number", "description": "Only include catalog hits with price at or below this amount (major currency units)." }, "inStock": { "title": "In stock only", "type": "boolean", "description": "Prefer products marked available in the catalog.", "default": false }, "shipsTo": { "title": "Ships to country", "type": "string", "description": "Optional ISO country code filter for shipping destination (e.g. US)." }, "shipsFrom": { "title": "Treat location as ships-from", "type": "boolean", "description": "When storeLocation is a country code, apply it as ships-from instead of ships-to.", "default": false }, "enrichWebsite": { "title": "Enrich website contacts", "type": "boolean", "description": "Fetch the store homepage / contact pages for public emails, phones, and social links. Slower.", "default": false }, "websiteEnrichmentMode": { "title": "Website enrichment mode", "enum": [ "all", "missing_email" ], "type": "string", "description": "When enriching, check all stores or only those still missing an email.", "default": "missing_email" }, "skipPreviouslyScraped": { "title": "Skip previously scraped", "type": "boolean", "description": "Skip stores already returned for the same search (or shared lead list).", "default": false }, "leadListName": { "title": "Shared lead list name", "type": "string", "description": "Optional shared skip history across different searches. Requires skipPreviouslyScraped." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy. Helpful for website enrichment on rate-limited storefronts." } } }, "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 } } } } } } } } } }