{
  "openapi": "3.0.1",
  "info": {
    "title": "App Store Scraper & API - App Data, Ratings & Reviews",
    "description": "Scrape the Apple App Store: rating, ratings count, 1-5 star histogram, chart position, version, price and developer, plus reviews with stars, title, text, date and version. Top charts, any or all countries. Privacy-safe, verified.",
    "version": "0.1",
    "x-build-id": "aNcs2QBe44iPIBXJK"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/surefeed~app-store-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-surefeed-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/surefeed~app-store-scraper/runs": {
      "post": {
        "operationId": "runs-sync-surefeed-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/surefeed~app-store-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-surefeed-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": {
          "apps": {
            "title": "Apps",
            "type": "array",
            "description": "One app per line: its numeric id (389801252) or its App Store link (https://apps.apple.com/us/app/instagram/id389801252).",
            "items": {
              "type": "string"
            }
          },
          "searchTerms": {
            "title": "Or search apps by name",
            "type": "array",
            "description": "Optional: app names or keywords; the first results of each search are added (see \"Results per search\").",
            "items": {
              "type": "string"
            }
          },
          "resultsPerSearch": {
            "title": "Results per search",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many apps to take from each name search.",
            "default": 5
          },
          "charts": {
            "title": "Or top charts",
            "type": "array",
            "description": "Optional: add the apps of Apple's top charts in each country (rank included in topChart).",
            "items": {
              "type": "string",
              "enum": [
                "top-free",
                "top-paid",
                "top-grossing"
              ]
            },
            "default": []
          },
          "chartCategory": {
            "title": "Chart category",
            "enum": [
              "",
              "Books",
              "Business",
              "Developer Tools",
              "Education",
              "Entertainment",
              "Finance",
              "Food & Drink",
              "Games",
              "Graphics & Design",
              "Health & Fitness",
              "Lifestyle",
              "Medical",
              "Music",
              "Navigation",
              "News",
              "Photo & Video",
              "Productivity",
              "Reference",
              "Shopping",
              "Social Networking",
              "Sports",
              "Travel",
              "Utilities",
              "Weather"
            ],
            "type": "string",
            "description": "Optional: a category for the top charts (empty = all apps).",
            "default": ""
          },
          "chartLimit": {
            "title": "Apps per chart",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many top apps to take from each chart (up to 200).",
            "default": 25
          },
          "includeAppDetails": {
            "title": "App data",
            "type": "boolean",
            "description": "One result per app and country: rating, number of ratings, 1–5 star histogram, version and release notes, price, developer, category, age rating, size, languages, icon and screenshots.",
            "default": true
          },
          "maxReviews": {
            "title": "Max reviews per app and country",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "How many reviews to get (0 = none). Apple publishes up to 500 reviews per country and order; add countries to get more.",
            "default": 100
          },
          "sortReviews": {
            "title": "Review order",
            "enum": [
              "mostrecent",
              "mosthelpful"
            ],
            "type": "string",
            "description": "Most recent or most helpful first.",
            "default": "mostrecent"
          },
          "starRatings": {
            "title": "Only these star ratings",
            "type": "array",
            "description": "Optional: keep only reviews with these ratings, e.g. [1, 2] for complaints. Empty = all.",
            "default": []
          },
          "reviewsSince": {
            "title": "Reviews since",
            "type": "string",
            "description": "Optional date (YYYY-MM-DD): skip older reviews. With \"Most recent\" the run stops as soon as it reaches older ones — ideal for daily monitoring."
          },
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "App Store countries (two-letter codes: us, gb, it, de…), or \"all\" for every country. Ratings, charts and reviews are per country; each country is a separate result. Apple publishes up to 500 reviews per app and country, so more countries = more reviews.",
            "default": [
              "us"
            ],
            "items": {
              "type": "string"
            }
          },
          "includeReviewerNames": {
            "title": "Include reviewer nicknames",
            "type": "boolean",
            "description": "Off by default: nicknames can identify people. Turn on only if you have a lawful reason to process them (GDPR and similar laws).",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}