{ "openapi": "3.0.1", "info": { "title": "Niche Website Finder — Shopify Storefront Search", "description": "Find niche Shopify storefronts by keyword. Returns store URL + domain. PPE: start ~$0.005 + ~$0.02 per storefront + shopify-verified $0.002 when /products.json or meta.json verify succeeds (or demo fixtures). SoftCTA mesh to Shopify Owner Email / Contact Info / B2B.", "version": "0.1", "x-build-id": "b3ZV9M1qibfK9aSl1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/intelscrape~niche-website-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-intelscrape-niche-website-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/intelscrape~niche-website-finder/runs": { "post": { "operationId": "runs-sync-intelscrape-niche-website-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/intelscrape~niche-website-finder/run-sync": { "post": { "operationId": "run-sync-intelscrape-niche-website-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": { "niche": { "title": "Niche / Genre", "type": "string", "description": "Primary niche keyword (e.g. skincare, fitness apparel). Optional if niches[] or startUrls provided.", "default": "skincare" }, "niches": { "title": "Extra niches", "type": "array", "description": "Additional niche keywords to fan out (OR). Merged with Niche / Genre.", "items": { "type": "string" } }, "platform": { "title": "E-commerce Platform", "enum": [ "Shopify", "WooCommerce", "Squarespace", "Wix", "Any E-commerce" ], "type": "string", "description": "Which platform should these stores be built on?", "default": "Shopify" }, "countryCode": { "title": "Search country", "type": "string", "description": "Google Search countryCode (us, gb, ca, au, de, fr…). Rival parity with clearpath storeLocation / george country.", "default": "us" }, "languageCode": { "title": "Search language", "type": "string", "description": "Google Search languageCode (en, de, fr…). Use local-language niches for non-English markets.", "default": "en" }, "tldFilter": { "title": "TLD filter", "type": "array", "description": "Keep only domains ending in these TLDs (e.g. com, co.uk, com.au, de). Empty = any.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop SERP rows whose title/description/URL contain any of these (case-insensitive).", "items": { "type": "string" } }, "startUrls": { "title": "Start store URLs", "type": "array", "description": "Optional known storefront URLs to include (skips junk filters on vendor roots). Discovery still runs when niche/niches set.", "items": { "type": "string" } }, "verifyShopify": { "title": "Verify Shopify (/products.json)", "type": "boolean", "description": "When platform=Shopify, probe /products.json (or meta.json) and only return verified storefronts. Each verified store also fires PPE event shopify-verified ($0.002). Non-Shopify platforms ignore this flag. Default on for honest verified-only delivery.", "default": true }, "includeSnippets": { "title": "Include SERP title/description", "type": "boolean", "description": "Attach Google title + description snippets to each row.", "default": true }, "maxResults": { "title": "Max Websites to Find", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of unique store URLs to generate.", "default": 100 }, "demoMode": { "title": "Demo mode (fixture storefronts)", "type": "boolean", "description": "Skip Google Search. Push ≥3 fictional Shopify-verified fixture rows (source=demo) for format/PPE smoke tests. Not live inventory — do not use for production decisions. Still pushes SoftCTA stores-batch-summary. Each fixture with shopifyVerified=true charges shopify-verified $0.002 when PPE live.", "default": false } } }, "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 } } } } } } } } } }