Shopify Scraper API

High-performance async API for scraping Shopify store data including products, apps, themes, and comprehensive store information. Built and optimized for Apify platform.

🚀 Features

• Fast & Async - Utilizes async/await for superior performance
• Multiple Modes - Products, Search, Single Product, Apps Detection, Theme Info, Store Info
• Flexible Deployment - Run as API server or one-time scraper
• Type Safe - Full Pydantic validation for all inputs and outputs
• Apify Integration - Native support for Apify datasets and storage

📋 Supported Endpoints

1. Products Mode

Fetch products from a Shopify store with pagination.

Input:

• storeUrl - Shopify store URL (e.g., allbirds.com)
• limit - Products per page (1-250, default: 20)
• page - Page number (default: 1)

Output: Array of products with variants, images, pricing, and metadata

---

2. Search Mode

Search for products by keyword.

Input:

• storeUrl - Shopify store URL
• searchQuery - Search term
• limit - Results per page (1-40, default: 10)

Output: Array of matching products

---

3. Single Product Mode

Get detailed information for a specific product.

Input:

• storeUrl - Shopify store URL
• productHandle - Product handle/slug

Output: Single product with full details

---

4. Apps Detection Mode

Detect installed Shopify apps and theme.

Input:

• storeUrl - Shopify store URL

Output: List of detected apps and theme information

---

5. Theme Info Mode

Extract theme information from store.

Input:

• storeUrl - Shopify store URL

Output: Theme details including name, ID, and store URL

---

6. Store Info Mode

Get comprehensive store information.

Input:

• storeUrl - Shopify store URL

Output: Store metadata, social links, contact info, pages, and more

---

🎯 Usage on Apify

One-Time Scraping

1. Select the desired mode (products, search, etc.)
2. Enter the store URL
3. Configure additional parameters (limit, page, query, etc.)
4. Run the actor
5. Results will be saved to the dataset

API Server Mode

1. Set runAsApi to true
2. The actor will start a FastAPI server
3. Access the API at the provided URL
4. Interactive docs available at /docs

---

📊 Output Format

Products Output

{
  "id": 123456789,
  "title": "Product Name",
  "handle": "product-handle",
  "description": "Product description...",
  "price": 29.99,
  "compare_at_price": 39.99,
  "vendor": "Brand Name",
  "product_type": "Category",
  "tags": ["tag1", "tag2"],
  "variants": [...],
  "images": [...],
  "url": "https://store.com/products/handle"
}

Apps Detection Output

{
  "store": "https://store.com",
  "theme": "Dawn",
  "detected_apps": ["Klaviyo", "Yotpo", "Google Analytics"]
}

---

🔧 API Server Endpoints

When running in API server mode (runAsApi: true):

• GET / - API information
• GET /docs - Interactive API documentation
• GET /products - List products
• GET /search - Search products
• GET /single - Get single product
• GET /apps - Detect apps and theme
• GET /theme - Get theme info
• GET /info - Get store info

---

⚡ Performance

• Async I/O - Non-blocking requests for maximum throughput
• Concurrent Fetching - Multiple products fetched in parallel
• Connection Pooling - Reusable HTTP connections
• Type Validation - Pydantic models for data integrity

---

📝 Examples

Example 1: Scrape All Products

{
  "mode": "products",
  "storeUrl": "allbirds.com",
  "limit": 50,
  "page": 1
}

Example 2: Search for Products

{
  "mode": "search",
  "storeUrl": "allbirds.com",
  "searchQuery": "runner",
  "limit": 20
}

Example 3: Get Single Product

{
  "mode": "single",
  "storeUrl": "allbirds.com",
  "productHandle": "mens-tree-runner"
}

Example 4: Detect Apps

{
  "mode": "apps",
  "storeUrl": "https://allbirds.com"
}

---

🤝 Support

For issues or questions, please contact support or create an issue in the repository.