{
  "openapi": "3.0.1",
  "info": {
    "title": "WooCommerce Store Leads – Wix, Squarespace & BigCommerce",
    "description": "Find WooCommerce, Wix, Squarespace and BigCommerce stores by niche keyword, or detect the platform of your own domain list. Get product count, price range (WooCommerce), currency, socials and public business emails/phones. Pay only for confirmed stores. No proxy or login.",
    "version": "0.1",
    "x-build-id": "BKmTR2857LLuRj2Ka"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/hapol~ecommerce-store-leads/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-hapol-ecommerce-store-leads",
        "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/hapol~ecommerce-store-leads/runs": {
      "post": {
        "operationId": "runs-sync-hapol-ecommerce-store-leads",
        "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/hapol~ecommerce-store-leads/run-sync": {
      "post": {
        "operationId": "run-sync-hapol-ecommerce-store-leads",
        "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": {
          "domains": {
            "title": "Domains or URLs to check",
            "type": "array",
            "description": "e.g. coraandspink.com, https://www.shopmemor.com or a Wix free site like https://name.wixsite.com/site. Each is checked for WooCommerce, BigCommerce, Wix or Squarespace and for public products.",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "title": "Discovery keywords (niche)",
            "type": "array",
            "description": "e.g. \"handmade ceramics\", \"skincare\". Candidate sites are found by search, then the platform and store are verified.",
            "items": {
              "type": "string"
            }
          },
          "platforms": {
            "title": "Platforms",
            "type": "array",
            "description": "Only stores on these platforms are output and charged. Shopify is never charged here; use our Shopify Store Leads actor for Shopify.",
            "items": {
              "type": "string",
              "enum": [
                "woocommerce",
                "bigcommerce",
                "wix",
                "squarespace"
              ],
              "enumTitles": [
                "WooCommerce",
                "BigCommerce",
                "Wix",
                "Squarespace"
              ]
            },
            "default": [
              "woocommerce",
              "bigcommerce",
              "wix",
              "squarespace"
            ]
          },
          "discoveryMethod": {
            "title": "Discovery method",
            "enum": [
              "google-search-actor",
              "bing"
            ],
            "type": "string",
            "description": "Google (default, recommended) runs apify/google-search-scraper on your own Apify account (~$0.0045 per results page on the Free tier) with platform footprint queries; in our tests 22–35% of checked sites were confirmed stores. Bing is free but best-effort with a low hit rate (0 stores in the same tests): plain niche queries only. Only used when you give keywords.",
            "default": "google-search-actor"
          },
          "maxSearchPagesPerQuery": {
            "title": "Search pages per query",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Search result pages per query. Default 1 (each Google page costs ~$0.0045 on your account); Bing pages are free (~30 results each).",
            "default": 1
          },
          "maxStores": {
            "title": "Max stores",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Maximum confirmed stores to output.",
            "default": 100
          },
          "enriched": {
            "title": "Enriched mode",
            "type": "boolean",
            "description": "Adds contacts from contact/about pages, a larger WooCommerce price sample (100 products) and more BigCommerce sitemap pages. Extra charge per store.",
            "default": false
          },
          "roleEmailsOnly": {
            "title": "Role emails only",
            "type": "boolean",
            "description": "Keep only generic business addresses (info@, support@, hello@…). Recommended for GDPR.",
            "default": true
          },
          "includeNonStores": {
            "title": "Include non-store results",
            "type": "boolean",
            "description": "Also output sites that aren't confirmed stores: unknown platform, blocked, Shopify, or a platform site without public products (free, not charged).",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Not needed for most sites. Sites behind Cloudflare challenges are reported as blocked rather than retried.",
            "default": {
              "useApifyProxy": 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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}