{ "openapi": "3.0.1", "info": { "title": "App Store Chart Breakout Scanner", "description": "Finds apps breaking out across multiple Apple App Store markets at once. Official Apple RSS feeds only. No reviews, no developer names, no personal data.", "version": "1.1", "x-build-id": "YKbBHvD3A174XAqtp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/perpetual_ocher~app-store-chart-breakout-scanner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-perpetual_ocher-app-store-chart-breakout-scanner", "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/perpetual_ocher~app-store-chart-breakout-scanner/runs": { "post": { "operationId": "runs-sync-perpetual_ocher-app-store-chart-breakout-scanner", "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/perpetual_ocher~app-store-chart-breakout-scanner/run-sync": { "post": { "operationId": "run-sync-perpetual_ocher-app-store-chart-breakout-scanner", "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": { "storefrontPreset": { "title": "Storefront preset", "enum": [ "top10", "top30", "top50", "custom" ], "type": "string", "description": "Which set of Apple App Store country storefronts to scan. Choose 'custom' to supply your own list below.", "default": "top10" }, "storefronts": { "title": "Custom storefronts", "type": "array", "description": "ISO 3166-1 alpha-2 country codes, e.g. us, gb, jp. Only used when the preset is set to 'custom'.", "default": [], "items": { "type": "string" } }, "chartTypes": { "title": "Chart types", "type": "array", "description": "Which Apple charts to scan. Apple publishes top-free and top-paid for apps.", "items": { "type": "string", "enum": [ "top-free", "top-paid" ], "enumTitles": [ "Top Free", "Top Paid" ] }, "default": [ "top-free" ] }, "chartDepth": { "title": "Chart depth", "minimum": 10, "maximum": 100, "type": "integer", "description": "How many ranks deep to read per chart. Apple's feed caps at 100.", "default": 50 }, "maxResults": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Hard cap on rows written to the dataset. You are charged per row delivered.", "default": 1000 }, "newReleaseWindowDays": { "title": "New release window (days)", "minimum": 1, "type": "integer", "description": "An app first released within this many days counts as a new release for breakout detection.", "default": 90 }, "minMarketsForBreakout": { "title": "Minimum markets for breakout", "minimum": 1, "type": "integer", "description": "How many scanned markets an app must chart in (while also being a new release) to be flagged as a multi-market breakout.", "default": 3 }, "onlyBreakouts": { "title": "Only return breakouts", "type": "boolean", "description": "Drop every row that is not flagged as a multi-market breakout. Cuts your bill when you only want the signal.", "default": false }, "outputGranularity": { "title": "Output granularity", "enum": [ "market-row", "app-summary" ], "type": "string", "description": "'market-row' emits one row per app per market per chart (best for rank tracking). 'app-summary' emits one row per app per chart with a per-market rank map (typically 10-30x fewer billable rows).", "default": "market-row" }, "sortBy": { "title": "Sort by", "enum": [ "breadth_score", "markets_charting", "rank", "newest" ], "type": "string", "description": "How to order rows in the output dataset.", "default": "breadth_score" } } }, "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 } } } } } } } } } }