{ "openapi": "3.0.1", "info": { "title": "App Store Scraper - In-App Purchases, Ratings & Competitors", "description": "Apple App Store scraper & API: app details, 1-5 star ratings histogram, in-app purchase prices, privacy labels, app events, similar apps and developer apps for any country. Find competitors automatically, monitor version & price changes.", "version": "1.0", "x-build-id": "mfY5wn6yZWSy7r65c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/suerte_enero~app-store-iap-competitors-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-suerte_enero-app-store-iap-competitors-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/suerte_enero~app-store-iap-competitors-scraper/runs": { "post": { "operationId": "runs-sync-suerte_enero-app-store-iap-competitors-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/suerte_enero~app-store-iap-competitors-scraper/run-sync": { "post": { "operationId": "run-sync-suerte_enero-app-store-iap-competitors-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": "App Store URLs, app ids (284882215) or bundle ids (com.facebook.Facebook).", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Find apps by keyword, e.g. \"budget planner\". Up to 200 apps per term.", "items": { "type": "string" } }, "developers": { "title": "Developers", "type": "array", "description": "Developer URLs or ids (apps.apple.com/us/developer/king/id526656015) — returns all their apps.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "App Store countries as 2-letter codes (us, gb, de, jp, br…) or \"all\" for 100 storefronts.", "default": [ "us" ], "items": { "type": "string" } }, "maxAppsPerSearch": { "title": "Apps per search term", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many search results to take per term.", "default": 50 }, "expandCompetitors": { "title": "Find competitors", "type": "boolean", "description": "Also scrape the apps Apple lists as similar (\"You might also like\") and the developer's other apps for every input app.", "default": false }, "includePageData": { "title": "Ratings histogram, in-app purchases & privacy", "type": "boolean", "description": "Add the 1-5 star ratings breakdown, in-app purchase names and prices, privacy labels, app events, similar apps and 'What's New'.", "default": true }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "App pages loaded in parallel.", "default": 4 }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after saving this many records. You are charged only for saved records.", "default": 1000 }, "onlyNew": { "title": "Only new or changed apps (monitoring)", "type": "boolean", "description": "Remember apps this feed already returned; next runs save only new apps and apps whose version, price, name or in-app purchase prices changed (recordType \"updated\" with a list of changes).", "default": false }, "includeUpdated": { "title": "Also return changed records", "type": "boolean", "description": "In monitoring mode, also save known records whose important fields changed (date, price, sold out, venue…). They come with recordType \"updated\" and a list of changes.", "default": true }, "monitorId": { "title": "Feed name", "type": "string", "description": "Optional name for the monitoring feed, e.g. \"sf-ai-events\". Runs with the same name share memory. Leave empty to derive it from the search settings." }, "memoryDays": { "title": "Remember records for (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Monitoring memory forgets records not seen for this many days.", "default": 90 }, "outputFormat": { "title": "Output format", "enum": [ "full", "flat" ], "type": "string", "description": "\"full\" keeps nested objects (best for JSON / API). \"flat\" turns them into plain columns for Excel and Google Sheets.", "default": "full" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. At the end of the run, POST the saved records (up to 200) to this URL: Slack incoming webhook, Zapier, Make, n8n or your own endpoint. Not sent when nothing was saved." }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "\"slack\" sends a readable message, \"json\" sends the records and run summary.", "default": "json" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed in most cases. If the site starts throttling, the Actor switches to Apify Proxy by itself.", "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 } } } } } } } } } }