{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify App Store Scraper",
    "description": "Scrape Shopify App Store apps, pricing plans, ratings and merchant reviews by search, category or app URL. Works with Apify MCP and the API.",
    "version": "0.2",
    "x-build-id": "1KuyoDkEedri96jhJ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/khadinakbar~shopify-app-store-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-khadinakbar-shopify-app-store-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/khadinakbar~shopify-app-store-scraper/runs": {
      "post": {
        "operationId": "runs-sync-khadinakbar-shopify-app-store-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/khadinakbar~shopify-app-store-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-khadinakbar-shopify-app-store-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": {
          "queries": {
            "title": "Search queries",
            "type": "array",
            "description": "Free-text keywords searched on the Shopify App Store, one niche per line (e.g. 'email marketing'). Each query returns ranked app cards (searchRank, sponsored flag). Leave empty if you pass URLs in 'Start URLs' or use sitemap mode. NOT an app URL.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Direct apps.shopify.com URLs, mode auto-detected per URL. App page (/klaviyo-email-marketing) = full app detail; /reviews URL = merchant reviews; /categories/<slug> URL = the WHOLE category ranked list (categoryRank, every page); /partners/<developer> URL = all apps of one developer; /search?q= URL = a search.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "mode": {
            "title": "Mode",
            "enum": [
              "auto",
              "search",
              "category",
              "app_detail",
              "reviews",
              "developer"
            ],
            "type": "string",
            "description": "Forces a scraping mode instead of auto-detecting from the URL. Leave on 'auto' unless you need to override detection (for example force 'reviews' on a bare app URL).",
            "default": "auto"
          },
          "scrapeReviews": {
            "title": "Also scrape reviews for each app",
            "type": "boolean",
            "description": "Also collect merchant reviews for every app returned (one record per review, billed per review). Review pages are fetched in parallel, so large review pulls finish much faster. Ignored when the input is already a /reviews URL. Default false.",
            "default": false
          },
          "enrichDetails": {
            "title": "Enrich search/category results with full detail",
            "type": "boolean",
            "description": "For search, category and developer results, open each app's detail page to add description, pricing plans, rating breakdown, works-with and languages instead of just the listing card. Slower; app price is the same either way. Default false.",
            "default": false
          },
          "maxApps": {
            "title": "Max apps per query/category",
            "minimum": 1,
            "maximum": 30000,
            "type": "integer",
            "description": "Max apps returned per search query, category, developer, or in sitemap mode in total. Caps the app charge so cost stays predictable. Default 50. Up to 30000 for whole-store pulls.",
            "default": 50
          },
          "maxReviews": {
            "title": "Max reviews per app",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Max reviews per app (10 per page). Caps the review charge. Default 100. Applies when scraping reviews (a /reviews URL, or 'Also scrape reviews').",
            "default": 100
          },
          "reviewSort": {
            "title": "Review sort order",
            "enum": [
              "most_recent",
              "highest_rating",
              "lowest_rating",
              "most_helpful"
            ],
            "type": "string",
            "description": "Order of reviews. 'most_recent' (default) = newest first; 'highest_rating' / 'lowest_rating' sort by stars; 'most_helpful' uses Shopify's helpfulness ranking. Use newest first together with 'Only reviews since'.",
            "default": "most_recent"
          },
          "reviewRating": {
            "title": "Filter reviews by star rating",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Only reviews with exactly this star rating (1-5). 0 = all. For several star levels at once use 'Star ratings to include' instead.",
            "default": 0
          },
          "reviewRatings": {
            "title": "Star ratings to include",
            "type": "array",
            "description": "Pick several star levels at once, e.g. 1 and 2 for all complaints. Leave empty for all stars. Combines with 'Filter reviews by star rating'.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5"
              ]
            },
            "default": []
          },
          "reviewsSince": {
            "title": "Only reviews since (date)",
            "type": "string",
            "description": "Only reviews posted on or after this date, format YYYY-MM-DD (for example 2026-10-01). Works best with 'Most recent' sort: scraping stops once reviews get older than the date, so you are not billed for old reviews."
          },
          "onlyChanged": {
            "title": "Only new or changed apps",
            "type": "boolean",
            "description": "Return only apps that are new or whose rating, review count, price or plans changed since your last run with this option on. Unchanged apps are skipped and NOT billed. Each returned app gets changeStatus 'new' or 'changed'. State is kept between runs automatically.",
            "default": false
          },
          "sitemapMode": {
            "title": "Whole-store sitemap mode",
            "type": "boolean",
            "description": "Scrape app detail for the whole store (about 22,000 apps) from Shopify's sitemap, no search terms needed. Combine with 'Sitemap since date' to get only recently updated apps, and 'Max apps' to cap spend. Uses 1 GB memory automatically.",
            "default": false
          },
          "sitemapSince": {
            "title": "Sitemap since date",
            "type": "string",
            "description": "Sitemap mode only: only apps whose listing changed on or after this date (YYYY-MM-DD). Leave empty for every app. Pair with 'Only new or changed apps' to track the store daily."
          },
          "country": {
            "title": "Proxy country",
            "type": "string",
            "description": "Two-letter country code for the Apify residential/datacenter proxy egress (e.g. 'US', 'GB'). Affects geo-targeted pricing/currency shown on listings. Defaults to 'US'. Uppercase ISO-3166 alpha-2.",
            "default": "US"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Maximum parallel requests. Default 10. Lower it (for example 5) on very large jobs if you hit rate limits (HTTP 429). Raising it rarely helps.",
            "default": 10
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify proxy settings. The default is enough: apps.shopify.com is not aggressively bot-protected. Override only for a specific proxy group or country.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}