{
  "openapi": "3.0.1",
  "info": {
    "title": "App Store Revenue & Downloads Estimator",
    "description": "Estimate App Store downloads and revenue for any iPhone app in 175 countries: Top Free, Paid and Grossing ranks, price, rating growth and low/mid/high bands from a rank model calibrated on published figures. Directional estimates, not Apple data.",
    "version": "0.1",
    "x-build-id": "MXKltF7ZGB0FWcxX1"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/gazidev~app-revenue-estimator/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-gazidev-app-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/gazidev~app-revenue-estimator/runs": {
      "post": {
        "operationId": "runs-sync-gazidev-app-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/gazidev~app-revenue-estimator/run-sync": {
      "post": {
        "operationId": "run-sync-gazidev-app-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",
        "properties": {
          "apps": {
            "title": "Apps (IDs, App Store URLs or bundle IDs)",
            "type": "array",
            "description": "Apps to estimate. Accepts numeric App Store IDs (324684580), App Store URLs (https://apps.apple.com/us/app/spotify/id324684580) or bundle IDs (com.spotify.client).",
            "items": {
              "type": "string"
            }
          },
          "countries": {
            "title": "Countries (App Store storefronts)",
            "type": "array",
            "description": "Two-letter storefront codes (us, gb, de, jp, tr...). \"top\" = 30 largest storefronts, \"all\" = all 175. The first country of each app is charged as an app estimate, each further country as an extra country.",
            "default": [
              "us"
            ],
            "items": {
              "type": "string"
            }
          },
          "estimateTopChart": {
            "title": "Also estimate a whole top chart",
            "enum": [
              "none",
              "top-free",
              "top-paid",
              "top-grossing"
            ],
            "type": "string",
            "description": "Adds every app of this chart (per country, up to the limit below) to the run. Uses Apple's public RSS top charts (iPhone, overall).",
            "default": "none"
          },
          "topChartLimit": {
            "title": "Top chart: number of apps",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many apps of the chart to estimate per country (1-100).",
            "default": 25
          },
          "developers": {
            "title": "Developers (IDs or developer URLs)",
            "type": "array",
            "description": "Optional. Estimates the apps of these developers, e.g. 284882218 or https://apps.apple.com/us/developer/meta-platforms-inc/id284882218. Apps are taken by rating count, up to the limit below.",
            "items": {
              "type": "string"
            }
          },
          "maxAppsPerDeveloper": {
            "title": "Max apps per developer",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Most-rated apps taken per developer and country.",
            "default": 20
          },
          "publisherRollups": {
            "title": "Publisher rollups",
            "type": "boolean",
            "description": "Adds one row per developer and country with the summed download and revenue bands of that developer's apps in this run (charged as publisher-rollup). Made for each developer listed above and for any developer with 2+ apps in the run.",
            "default": false
          },
          "trackRatingGrowth": {
            "title": "Track rating growth between runs",
            "type": "boolean",
            "description": "Saves rating counts in a named key-value store. From the second (scheduled) run on, rows include rating count change and ratings per day, which improves estimates for apps that are not on a chart.",
            "default": true
          },
          "scanGenreCharts": {
            "title": "Scan genre charts",
            "type": "boolean",
            "description": "Also reads the genre top charts (top 100 per genre) of each app's primary genre. Gives a rank to apps that are outside the overall top 100 but high in their genre. Adds a few Apple RSS calls per genre and country.",
            "default": true
          },
          "historyStoreName": {
            "title": "History store name",
            "type": "string",
            "description": "Named key-value store for rating history. Use different names to keep separate projects apart.",
            "default": "app-revenue-estimator-history"
          },
          "countryMultipliers": {
            "title": "Country market-size overrides (advanced)",
            "type": "object",
            "description": "Optional overrides of the storefront size relative to the US, e.g. {\"de\": {\"downloads\": 0.15, \"revenue\": 0.11}}. Defaults are listed in the README."
          },
          "maxRequestsPerMinute": {
            "title": "Max Apple Lookup calls per minute",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Apple documents a limit of about 20 calls per minute for the iTunes Lookup API.",
            "default": 20
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}