{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Scraper API", "description": "Most App Store review tools stop at 500 reviews. Get every public review for any iPhone app, in any country: rating, title, text, author, app version, votes and developer replies, with star and date filters.", "version": "1.0", "x-build-id": "AceyEPzDpKaXh06r6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawl_craft~app-store-reviews-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawl_craft-app-store-reviews-scraper-api", "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/crawl_craft~app-store-reviews-scraper-api/runs": { "post": { "operationId": "runs-sync-crawl_craft-app-store-reviews-scraper-api", "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/crawl_craft~app-store-reviews-scraper-api/run-sync": { "post": { "operationId": "run-sync-crawl_craft-app-store-reviews-scraper-api", "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", "required": [ "urls" ], "properties": { "urls": { "title": "📱 App Store app links", "type": "array", "description": "One or many App Store app links (for example https://apps.apple.com/us/app/instagram/id389801252). Bulk input is supported. The storefront in a link is used when no countries are selected below.", "items": { "type": "string" } }, "appIds": { "title": "🆔 App IDs (optional)", "type": "array", "description": "Extra numeric App Store IDs, the digits at the end of an app link without the 'id' prefix (for example 389801252). Added to the links above.", "default": [], "items": { "type": "string" } }, "countries": { "title": "🌎 App Store countries", "type": "array", "description": "Storefronts to collect reviews from. Every country is collected separately and labelled in the country column. Leave empty to use the country in each link (United States when the link has none). Choose 'All storefronts' for every country.", "items": { "type": "string", "enum": [ "all", "us", "af", "al", "dz", "ao", "ai", "ag", "ar", "am", "au", "at", "az", "bs", "bh", "bb", "by", "be", "bz", "bj", "bm", "bt", "bo", "ba", "bw", "br", "vg", "bn", "bg", "bf", "kh", "cm", "ca", "cv", "ky", "td", "cl", "cn", "co", "cr", "hr", "cy", "cz", "ci", "cd", "dk", "dm", "do", "ec", "eg", "sv", "ee", "sz", "fj", "fi", "fr", "ga", "gm", "ge", "de", "gh", "gr", "gd", "gt", "gw", "gy", "hn", "hk", "hu", "is", "in", "id", "iq", "ie", "il", "it", "jm", "jp", "jo", "kz", "ke", "xk", "kw", "kg", "la", "lv", "lb", "lr", "ly", "lt", "lu", "mo", "mg", "mw", "my", "mv", "ml", "mt", "mr", "mu", "mx", "fm", "md", "mn", "me", "ms", "ma", "mz", "mm", "na", "np", "nl", "nz", "ni", "ne", "ng", "mk", "no", "om", "pk", "pw", "pa", "pg", "py", "pe", "ph", "pl", "pt", "qa", "cg", "ro", "ru", "rw", "kn", "lc", "vc", "sa", "sn", "rs", "sc", "sl", "sg", "sk", "si", "sb", "za", "kr", "es", "lk", "sr", "se", "ch", "st", "tw", "tj", "tz", "th", "to", "tt", "tn", "tm", "tc", "tr", "ug", "ua", "ae", "gb", "uy", "uz", "vu", "ve", "vn", "ye", "zm", "zw" ], "enumTitles": [ "All storefronts (every country)", "United States (US)", "Afghanistan (AF)", "Albania (AL)", "Algeria (DZ)", "Angola (AO)", "Anguilla (AI)", "Antigua and Barbuda (AG)", "Argentina (AR)", "Armenia (AM)", "Australia (AU)", "Austria (AT)", "Azerbaijan (AZ)", "Bahamas (BS)", "Bahrain (BH)", "Barbados (BB)", "Belarus (BY)", "Belgium (BE)", "Belize (BZ)", "Benin (BJ)", "Bermuda (BM)", "Bhutan (BT)", "Bolivia (BO)", "Bosnia and Herzegovina (BA)", "Botswana (BW)", "Brazil (BR)", "British Virgin Islands (VG)", "Brunei (BN)", "Bulgaria (BG)", "Burkina Faso (BF)", "Cambodia (KH)", "Cameroon (CM)", "Canada (CA)", "Cape Verde (CV)", "Cayman Islands (KY)", "Chad (TD)", "Chile (CL)", "China (CN)", "Colombia (CO)", "Costa Rica (CR)", "Croatia (HR)", "Cyprus (CY)", "Czech Republic (CZ)", "Côte d'Ivoire (CI)", "DR Congo (CD)", "Denmark (DK)", "Dominica (DM)", "Dominican Republic (DO)", "Ecuador (EC)", "Egypt (EG)", "El Salvador (SV)", "Estonia (EE)", "Eswatini (SZ)", "Fiji (FJ)", "Finland (FI)", "France (FR)", "Gabon (GA)", "Gambia (GM)", "Georgia (GE)", "Germany (DE)", "Ghana (GH)", "Greece (GR)", "Grenada (GD)", "Guatemala (GT)", "Guinea-Bissau (GW)", "Guyana (GY)", "Honduras (HN)", "Hong Kong (HK)", "Hungary (HU)", "Iceland (IS)", "India (IN)", "Indonesia (ID)", "Iraq (IQ)", "Ireland (IE)", "Israel (IL)", "Italy (IT)", "Jamaica (JM)", "Japan (JP)", "Jordan (JO)", "Kazakhstan (KZ)", "Kenya (KE)", "Kosovo (XK)", "Kuwait (KW)", "Kyrgyzstan (KG)", "Laos (LA)", "Latvia (LV)", "Lebanon (LB)", "Liberia (LR)", "Libya (LY)", "Lithuania (LT)", "Luxembourg (LU)", "Macau (MO)", "Madagascar (MG)", "Malawi (MW)", "Malaysia (MY)", "Maldives (MV)", "Mali (ML)", "Malta (MT)", "Mauritania (MR)", "Mauritius (MU)", "Mexico (MX)", "Micronesia (FM)", "Moldova (MD)", "Mongolia (MN)", "Montenegro (ME)", "Montserrat (MS)", "Morocco (MA)", "Mozambique (MZ)", "Myanmar (MM)", "Namibia (NA)", "Nepal (NP)", "Netherlands (NL)", "New Zealand (NZ)", "Nicaragua (NI)", "Niger (NE)", "Nigeria (NG)", "North Macedonia (MK)", "Norway (NO)", "Oman (OM)", "Pakistan (PK)", "Palau (PW)", "Panama (PA)", "Papua New Guinea (PG)", "Paraguay (PY)", "Peru (PE)", "Philippines (PH)", "Poland (PL)", "Portugal (PT)", "Qatar (QA)", "Republic of the Congo (CG)", "Romania (RO)", "Russia (RU)", "Rwanda (RW)", "Saint Kitts and Nevis (KN)", "Saint Lucia (LC)", "Saint Vincent and the Grenadines (VC)", "Saudi Arabia (SA)", "Senegal (SN)", "Serbia (RS)", "Seychelles (SC)", "Sierra Leone (SL)", "Singapore (SG)", "Slovakia (SK)", "Slovenia (SI)", "Solomon Islands (SB)", "South Africa (ZA)", "South Korea (KR)", "Spain (ES)", "Sri Lanka (LK)", "Suriname (SR)", "Sweden (SE)", "Switzerland (CH)", "São Tomé and Príncipe (ST)", "Taiwan (TW)", "Tajikistan (TJ)", "Tanzania (TZ)", "Thailand (TH)", "Tonga (TO)", "Trinidad and Tobago (TT)", "Tunisia (TN)", "Turkmenistan (TM)", "Turks and Caicos (TC)", "Türkiye (TR)", "Uganda (UG)", "Ukraine (UA)", "United Arab Emirates (AE)", "United Kingdom (GB)", "Uruguay (UY)", "Uzbekistan (UZ)", "Vanuatu (VU)", "Venezuela (VE)", "Vietnam (VN)", "Yemen (YE)", "Zambia (ZM)", "Zimbabwe (ZW)" ] }, "default": [] }, "maxItems": { "title": "📊 Maximum reviews", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Reviews to collect for each app in each country. 0 = everything the App Store serves.", "default": 10 }, "sort": { "title": "🔃 Sort reviews by", "enum": [ "recent", "helpful", "favorable", "critical" ], "type": "string", "description": "Order in which reviews are collected. Most recent is the cheapest way to get the latest reviews.", "default": "recent" }, "ratings": { "title": "⭐ Star ratings to keep", "type": "array", "description": "Keep only reviews with these star ratings. Leave empty to keep all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "dateFrom": { "title": "🗓 Reviews since", "pattern": "^(\\d{4}-\\d{2}-\\d{2}(T[0-9:.]+Z?)?|\\d+\\s*[dwmyDWMY])?$", "type": "string", "description": "Keep only reviews on or after this date. Use YYYY-MM-DD (for example 2026-01-01) or a window such as 30d, 2w, 6m or 1y. Leave empty for any date." }, "includeVersions": { "title": "🔖 Add app version", "type": "boolean", "description": "Add the app version each reviewer used. Only the newest and most helpful 500 reviews per app and country carry a version; older reviews have it empty. Adds a little run time.", "default": true }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "Optional. The default setting works for most runs. Choose your own proxy setup here if you need one.", "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 } } } } } } } } } }