{ "openapi": "3.0.1", "info": { "title": "Shopify Store Leads Scraper — $4/1K · Emails, Phones & Ratings", "description": "Discover Shopify sellers by keyword/category, origin and product filters. Public contacts with evidence, qualified emails, apps/theme, business addresses and optional catalog. Reuse lead lists to skip delivered domains; labeled rating/coverage scopes.", "version": "1.1", "x-build-id": "T724aOiycxopisgsm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~shopify-store-leads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-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/apivault_labs~shopify-store-leads-scraper/runs": { "post": { "operationId": "runs-sync-apivault_labs-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/apivault_labs~shopify-store-leads-scraper/run-sync": { "post": { "operationId": "run-sync-apivault_labs-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": { "searchTerms": { "title": "Niche keywords", "type": "array", "description": "Product keywords used to find matching public Shopify sellers. Bounded sample, not a merchant census. Clear this list to use only known URLs.", "items": { "type": "string" } }, "storeUrls": { "title": "Known Shopify store URLs", "type": "array", "description": "Optional public store URLs. Without explicit searchTerms, URLs disable the default keyword search. Country/rating search filters cannot be combined with URLs.", "items": { "type": "string" } }, "country": { "title": "Merchant origin country", "type": "string", "description": "Optional uppercase ISO country code such as US. Keyword search only; source merchant-origin filter, not verified headquarters.", "default": "" }, "maxStores": { "title": "Maximum delivered leads", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Output limit after filters. Subject to candidate, source and processing limits; not a promise of this many stores.", "default": 10 }, "maxPagesPerTerm": { "title": "Maximum product pages per keyword", "minimum": 1, "maximum": 20, "type": "integer", "description": "50 products per page; Catalog source cap 1000 products per search. Product coverage is not store coverage.", "default": 3 }, "enrichWebsite": { "title": "Read public contact pages", "type": "boolean", "description": "Visit homepage and a bounded number of same-domain contact/about/privacy pages. No login or browser challenge bypass.", "default": true }, "maxContactPages": { "title": "Additional contact pages per store", "minimum": 0, "maximum": 4, "type": "integer", "description": "Homepage is additional to this limit.", "default": 2 }, "requireEmail": { "title": "Only leads with a public email", "type": "boolean", "description": "Requires website enrichment. Excluded candidates do not create Dataset rows.", "default": false }, "requirePhone": { "title": "Only leads with a public phone", "type": "boolean", "description": "Requires website enrichment. Phone numbers are extracted from public tel links.", "default": false }, "minProductRating": { "title": "Minimum matching product rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Optional keyword search filter on a matching product/variant rating, not a seller rating. Minimum one source review. Applies through Catalog." }, "maxStoresScanned": { "title": "Maximum candidate stores scanned", "minimum": 1, "maximum": 10000, "type": "integer", "description": "New candidate budget before qualification. Catalog skips previously delivered domains while paging. Larger values help restrictive filters; source/time budgets still apply." }, "countries": { "title": "Merchant origin countries", "type": "array", "description": "ISO codes, OR matching through source ships_from. Does not establish headquarters. Keyword discovery only.", "items": { "type": "string" } }, "categories": { "title": "Product taxonomy categories", "type": "array", "description": "Current TaxonomyCategory GIDs, e.g. gid://shopify/TaxonomyCategory/fb. OR matching. Clear searchTerms for category-only search.", "items": { "type": "string" } }, "shipsTo": { "title": "Ships to country", "type": "string", "description": "ISO destination country; Catalog product filter, not store headquarters or delivery-date guarantee.", "default": "" }, "currency": { "title": "Price filter currency", "enum": [ "USD", "CAD", "AUD", "NZD", "GBP", "EUR", "JPY", "KRW", "CHF", "INR", "SGD", "HKD", "KWD", "BHD", "TND", "SEK", "NOK", "DKK", "PLN", "BRL", "MXN" ], "type": "string", "description": "Price source context and average-price filter currency. Never converts money silently.", "default": "USD" }, "priceMinMinor": { "title": "Minimum matching price", "minimum": 0, "type": "integer", "description": "Catalog product price in currency MINOR units:1000=10USD,1000=1000JPY. Keyword discovery only." }, "priceMaxMinor": { "title": "Maximum matching price", "minimum": 0, "type": "integer", "description": "Catalog product price in currency MINOR units:1000=10USD,1000=1000JPY. Keyword discovery only." }, "minProductReviews": { "title": "Minimum variant review count", "minimum": 1, "type": "integer", "description": "Used together with minProductRating; product/variant evidence is not store reputation.", "default": 1 }, "includeTechStack": { "title": "Detect public apps and theme", "type": "boolean", "description": "Observed HTML signatures with evidence; absence is not proof an app is uninstalled.", "default": true }, "includeBusinessDetails": { "title": "Read public business details", "type": "boolean", "description": "Published JSON-LD/HTML addresses, legal names, declared currency/country, policy links and tokenless Storefront settings. Missing remains unknown. Theme/app detection is a separate option.", "default": true }, "includeCatalog": { "title": "Read storefront catalog", "type": "boolean", "description": "Optional bounded products.json pagination; completeness and count lower bounds are explicit. Product details include variants/images/vendor/type/tags.", "default": false }, "maxProductsPerStore": { "title": "Maximum sampled products per store", "minimum": 1, "maximum": 2500, "type": "integer", "description": "1–2500. Reaching the cap is incomplete unless source exhaustion is observed.", "default": 100 }, "maxConcurrency": { "title": "Concurrent store enrichments", "minimum": 1, "maximum": 4, "type": "integer", "description": "Bounded1–4; results keep discovery order. Higher values can increase platform usage and source rate limits.", "default": 1 }, "validateEmails": { "title": "Check email-domain MX routing", "type": "boolean", "description": "Optional Google public DNS-over-HTTPS lookup. Never sends email or probes SMTP. MX is not mailbox deliverability; unavailable lookup stays unknown.", "default": false }, "requireBestEmail": { "title": "Only leads with a qualified email", "type": "boolean", "description": "Own-domain, public personal mailbox or labeled brand-domain heuristic. Excludes known vendor/noreply/privacy addresses from best_email.", "default": false }, "hasApps": { "title": "Required observed apps", "type": "array", "description": "Documented detector names, any/all matching. Requires a positive public signal.", "items": { "type": "string" } }, "excludeApps": { "title": "Exclude observed apps", "type": "array", "description": "Exclude observed signatures; protected website is unknown and excluded from this filter, not treated as no apps.", "items": { "type": "string" } }, "requireSocials": { "title": "Required social domains", "type": "array", "description": "All requested domains must appear, e.g.instagram.com or linkedin.com.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude name/product keywords", "type": "array", "description": "Case-insensitive match in store name, domain or discovery product sample.", "items": { "type": "string" } }, "vendorFilter": { "title": "Catalog product vendors", "type": "array", "description": "Case-insensitive exact vendor names; requires a matching sampled product.", "items": { "type": "string" } }, "productTypeFilter": { "title": "Catalog product types", "type": "array", "description": "Case-insensitive exact type names; requires a matching sampled product.", "items": { "type": "string" } }, "appMatchMode": { "title": "Required app matching", "enum": [ "any", "all" ], "type": "string", "description": "Match any or all required observed app signatures.", "default": "any" }, "minProducts": { "title": "Minimum catalog size", "minimum": 0, "type": "integer", "description": "Min uses observed lower bound; max requires a complete catalog. Unknown coverage cannot satisfy this filter." }, "maxProducts": { "title": "Maximum catalog size", "minimum": 0, "type": "integer", "description": "Min uses observed lower bound; max requires a complete catalog. Unknown coverage cannot satisfy this filter." }, "minAvgPrice": { "title": "Minimum sampled average price", "minimum": 0, "type": "number", "description": "Major units of selected currency. Requires observed store currency; sample average, not complete revenue." }, "maxAvgPrice": { "title": "Maximum sampled average price", "minimum": 0, "type": "number", "description": "Major units of selected currency. Requires observed store currency; sample average, not complete revenue." }, "activeWithinDays": { "title": "Recent product publication within days", "minimum": 0, "type": "integer", "description": "Observed product timestamps. Oldest publication requires complete catalog and is NOT verified store launch date." }, "launchedWithinDays": { "title": "Oldest catalog publication within days", "minimum": 0, "type": "integer", "description": "Observed product timestamps. Oldest publication requires complete catalog and is NOT verified store launch date." }, "createdSinceDays": { "title": "Product creation within days", "minimum": 0, "type": "integer", "description": "Observed product timestamps. Oldest publication requires complete catalog and is NOT verified store launch date." }, "onSale": { "title": "Require an observed sale product", "type": "boolean", "description": "Sample variant compare_at_price must exceed price. Enables storefront catalog reading.", "default": false }, "inStockOnly": { "title": "Only sale-ready catalog search products", "type": "boolean", "description": "Catalog availability filter in discovery; when storefront catalog is read, at least one matched available product is required.", "default": false }, "skipPreviouslyScraped": { "title": "Skip previously delivered leads", "type": "boolean", "description": "Persist delivery domains in your account named KV store. Enable from first run; use one run at a time per leadListName. Writes follow successful Dataset delivery.", "default": false }, "leadListName": { "title": "Lead history list name", "type": "string", "description": "Named account-scoped history,1–80letters/digits/_/-. Different lists are isolated. Concurrent runs on the same list are unsupported.", "default": "default" }, "previousDatasetId": { "title": "Exclude domains from an earlier Dataset", "type": "string", "description": "Your accessible Dataset ID, up to100000rows. Uses domain/store_url/websiteUrl; unavailable or oversized import fails instead of silently ignoring dedup." }, "renderJs": { "title": "JavaScript rendering", "enum": [ "off", "auto", "on" ], "type": "string", "description": "off=HTTP;auto=browser fallback after failed public HTML read;on=render public HTML.512MiB minimum. Does not log in or solve challenges. Chromium is serialized to bound memory.", "default": "off" }, "useApifyProxy": { "title": "Enable Apify Proxy", "type": "boolean", "description": "Opt-in paid proxy using platform proxy credential. Proxy charges are additional user-paid usage. No external proxy password is returned.", "default": false }, "proxyFallback": { "title": "Try direct HTTP before proxy", "type": "boolean", "description": "When proxy is enabled, use it only after direct failure. Disable to route source HTTP through configured proxy immediately.", "default": true }, "proxyCountry": { "title": "Proxy exit country", "type": "string", "description": "Optional ISO country, requires useApifyProxy. Does not replace merchant-origin filters.", "default": "" }, "proxyGroups": { "title": "Apify Proxy groups", "type": "array", "description": "Optional entitled group names such as RESIDENTIAL. Additional proxy charges and availability apply; no group is enabled by default.", "items": { "type": "string" } }, "respectRobots": { "title": "Respect public robots.txt", "type": "boolean", "description": "Opt-in: disallowed store paths are skipped; failed robots access is not silently treated as permission.", "default": false }, "discoverySource": { "title": "Discovery source", "enum": [ "catalog", "common_crawl" ], "type": "string", "description": "catalog=live matching product sellers;common_crawl=bounded historical myshopify URL candidates, verified against current storefronts. CC does not support Catalog keyword/origin/category/price filters.", "default": "catalog" }, "ccIndex": { "title": "Common Crawl index", "type": "string", "description": "Optional CC-MAIN-YYYY-NN. Empty uses the first archive returned by the public collection list. Historical URLs are not current contacts.", "default": "" }, "ccStartPage": { "title": "Common Crawl starting page", "minimum": 0, "maximum": 10000, "type": "integer", "description": "CDX index page, not store offset. Pages can overlap; domain/history dedup still applies.", "default": 0 }, "ccMaxPages": { "title": "Maximum Common Crawl pages", "minimum": 1, "maximum": 3, "type": "integer", "description": "Bounded1–3 requests, with spacing. Not a bulk crawl export.", "default": 1 }, "includePolicies": { "title": "Read public policy excerpts", "type": "boolean", "description": "Read up to maxPolicyPages discovered same-domain policy pages. Returns source/title/text excerpt, not legal interpretation.", "default": false }, "maxPolicyPages": { "title": "Maximum policy pages", "minimum": 0, "maximum": 4, "type": "integer", "description": "Additional bounded public policy reads, only when enabled.", "default": 2 }, "includeCollections": { "title": "Read public collections", "type": "boolean", "description": "Reads first250public collections; complete flag only if fewer than250. No hidden/private collections.", "default": false }, "collectionHandles": { "title": "Limit product reading to collections", "type": "array", "description": "Up to10public collection handles. Product count is then a subset/lower bound, never a full-store count. Enables catalog reading.", "items": { "type": "string" } }, "flatOutput": { "title": "Flat CSV-friendly output", "type": "boolean", "description": "Serialize arrays/objects as JSON strings in top-level columns, retaining evidence and scope.", "default": false }, "region": { "title": "Predefined merchant-origin region", "enum": [ "", "NORTH_AMERICA", "EUROPE", "ENGLISH_SPEAKING", "OCEANIA" ], "type": "string", "description": "Named targeting presets expanded to explicit ISO countries, not geopolitical completeness or verified headquarters. Combined by OR with country/countries.", "default": "" }, "minLeadScore": { "title": "Minimum data completeness score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Explicit heuristic:qualified email35,phone15,address10,social10,catalog10,app10,reachable website10. Not a conversion prediction or business revenue score.", "default": 0 }, "includeContacts": { "title": "Include public contacts", "type": "boolean", "description": "Return published emails/phones/socials/evidence. Disable for store fingerprint/catalog research; contact filters require this option.", "default": true }, "minPrice": { "title": "Minimum sampled storefront product price", "minimum": 0, "type": "number", "description": "Major units of the selected currency. Matches a sampled storefront variant; enables catalog. Unknown or different currency cannot satisfy this filter. Separate from Catalog search minor-unit price filters." }, "maxPrice": { "title": "Maximum sampled storefront product price", "minimum": 0, "type": "number", "description": "Major units of the selected currency. Matches a sampled storefront variant; enables catalog. Unknown or different currency cannot satisfy this filter. Separate from Catalog search minor-unit price filters." }, "shipsToCountries": { "title": "Required declared shipping destinations", "type": "array", "description": "Known-store/enrichment filter:all ISO destinations must appear in the public tokenless Storefront API or metadata declaration. Unknown does not match. Not a checkout/delivery guarantee; separate from Catalog product shipsTo.", "items": { "type": "string" } }, "websiteEnrichmentMode": { "title": "Contact page enrichment mode", "enum": [ "all", "missing_email" ], "type": "string", "description": "all=read bounded discovered contact pages;missing_email=skip extra contact pages if the homepage already exposes an email. Public business metadata can still be read.", "default": "all" } } }, "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 } } } } } } } } } }