{
  "openapi": "3.0.1",
  "info": {
    "title": "App Store Revenue & Download Estimator - iOS and Google Play",
    "description": "Estimate App Store and Google Play downloads and revenue from public signals (rank, rank history, ratings velocity, review deltas). Per-app records, modeled estimate bands, and publisher rollups. For app devs, UA/growth teams, and investors - the gated Sensor Tower/data.ai layer, priced per call.",
    "version": "0.1",
    "x-build-id": "EQxRaC2oplEd8NUHT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/seibs.co~app-store-revenue-estimator/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-seibs.co-app-store-revenue-estimator",
        "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/seibs.co~app-store-revenue-estimator/runs": {
      "post": {
        "operationId": "runs-sync-seibs.co-app-store-revenue-estimator",
        "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/seibs.co~app-store-revenue-estimator/run-sync": {
      "post": {
        "operationId": "run-sync-seibs.co-app-store-revenue-estimator",
        "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": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "app_estimate",
              "publisher_rollup",
              "top_charts",
              "estimate_monitor"
            ],
            "type": "string",
            "description": "app_estimate = app ids/URLs -> full metadata + a modeled download/revenue band per app. publisher_rollup = publisher names or Apple developer ids -> all their apps + per-app estimates + one portfolio rollup. top_charts = country + chart -> the top N apps with estimates (Apple feeds; Play degrades gracefully). estimate_monitor = a watchlist for Apify Schedules; standard monitor mode AND the mode that builds the time-series accuracy (each run adds a ratings-velocity point that sharpens future estimates).",
            "default": "app_estimate"
          },
          "apps": {
            "title": "Apps (iOS ids, Apple URLs, Play packages, or Play URLs)",
            "maxItems": 100,
            "type": "array",
            "description": "Apps to estimate. Accepts: an iOS numeric track id (e.g. '310633997'), an Apple App Store URL (e.g. 'https://apps.apple.com/us/app/whatsapp-messenger/id310633997'), a Google Play package id (e.g. 'com.whatsapp'), or a Play URL (e.g. 'https://play.google.com/store/apps/details?id=com.whatsapp'). Used by app_estimate and estimate_monitor. Hard cap of 100.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "publishers": {
            "title": "Publishers (developer name or Apple artistId)",
            "maxItems": 10,
            "type": "array",
            "description": "Publishers to roll up (publisher_rollup mode). Accepts a developer/company name (e.g. 'Calm.com, Inc.') resolved via App Store search, or an Apple developer artistId (e.g. '479516143'). Returns every app under that developer plus a combined portfolio band. Hard cap of 10.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country / storefront (ISO-2)",
            "type": "string",
            "description": "Two-letter storefront code for lookups and charts (e.g. 'us', 'gb', 'jp', 'de'). Affects pricing, chart contents, and the rank->downloads scaling (US is tier 1; large markets tier 2; the rest tier 3). Default 'us'.",
            "default": "us"
          },
          "chart": {
            "title": "Chart (top_charts mode)",
            "enum": [
              "top-free",
              "top-paid",
              "top-grossing"
            ],
            "type": "string",
            "description": "Which chart to pull in top_charts mode. top-free and top-paid use Apple's public marketing RSS feeds. top-grossing has no public Apple v2 feed, so it falls back to the top-free chart and estimates revenue from ratings velocity / category coefficients instead of a grossing-rank curve (noted on the run).",
            "default": "top-free"
          },
          "chart_category": {
            "title": "Chart category (optional)",
            "type": "string",
            "description": "Optional Apple genre filter for top_charts (a genre id like '6014' for Games, or a name). Leave empty for the overall chart. Note: the Apple marketing RSS feeds are overall-only in most storefronts, so this is best-effort and may be ignored when the storefront does not expose a per-genre feed.",
            "default": ""
          },
          "top_n": {
            "title": "Top N apps (top_charts mode)",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many top-chart apps to estimate (top_charts mode). Default 25. Hard cap of 200.",
            "default": 25
          },
          "include_play": {
            "title": "Include Google Play",
            "type": "boolean",
            "description": "When true, Play package ids are scraped from the public Play app page (best-effort; any block becomes a fetch_error and the run continues). When false, only Apple App Store ids are processed. Play has no top-charts feed, so top_charts is always Apple-only.",
            "default": true
          },
          "monitor_webhook_url": {
            "title": "Monitor webhook URL (Slack / email, optional)",
            "type": "string",
            "description": "When this actor runs under an Apify Schedule (estimate_monitor / monitor mode), post the change digest to this Slack-compatible webhook URL.",
            "default": ""
          },
          "use_apify_proxy": {
            "title": "Use Apify Proxy",
            "type": "boolean",
            "description": "Route requests through Apify Proxy. DATACENTER is sufficient for the Apple iTunes endpoints and usually for Google Play; escalate to RESIDENTIAL only if Play starts blocking.",
            "default": true
          },
          "apify_proxy_groups": {
            "title": "Proxy groups",
            "type": "array",
            "description": "Apify Proxy groups. DATACENTER is the default and fine for Apple. Add RESIDENTIAL if Google Play blocks your datacenter IPs.",
            "default": [
              "DATACENTER"
            ],
            "items": {
              "type": "string"
            }
          },
          "concurrency": {
            "title": "Max concurrent requests",
            "minimum": 1,
            "maximum": 8,
            "type": "integer",
            "description": "Parallel app fetches. Default 4. Kept modest to stay a polite, proportionate visitor.",
            "default": 4
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}