{
  "openapi": "3.0.1",
  "info": {
    "title": "App Store Scraper: Apple App Details & Top Charts by Country",
    "description": "Get App Store app details (price, rating, version, developer, size, category) and Top Free / Top Paid charts (up to 200 ranks) for any country, category and iPhone / iPad / Mac, with rank changes between runs. Official Apple endpoints only, no reviews, robots.txt compliant.",
    "version": "0.1",
    "x-build-id": "4tukj7Mm36DDZa6vI"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/latamdatatools~apple-app-store-charts-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-latamdatatools-apple-app-store-charts-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/latamdatatools~apple-app-store-charts-scraper/runs": {
      "post": {
        "operationId": "runs-sync-latamdatatools-apple-app-store-charts-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/latamdatatools~apple-app-store-charts-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-latamdatatools-apple-app-store-charts-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": {
          "appIds": {
            "title": "Apps (IDs, App Store URLs or bundle IDs)",
            "type": "array",
            "description": "Apps to get full details for. Accepts numeric IDs (6448311069), App Store URLs (https://apps.apple.com/us/app/chatgpt/id6448311069) or bundle IDs (com.openai.chat). Each app found is one result per country.",
            "items": {
              "type": "string"
            }
          },
          "developerIds": {
            "title": "Developers (all their apps)",
            "type": "array",
            "description": "Developer IDs or developer page URLs (https://apps.apple.com/us/developer/meta-platforms-inc/id284882218). Returns every app of the developer (up to 200).",
            "items": {
              "type": "string"
            }
          },
          "countries": {
            "title": "Countries (storefronts)",
            "type": "array",
            "description": "2-letter ISO country codes. Apps and charts are fetched for every country listed (prices, ratings and rankings differ per country).",
            "default": [
              "us"
            ],
            "items": {
              "type": "string"
            }
          },
          "chartCategories": {
            "title": "Top Charts: categories",
            "type": "array",
            "description": "Leave empty to skip charts. Category IDs or names: 36 or \"All Apps\" (overall chart), 6014 or \"Games\", 6007 \"Productivity\", 6015 \"Finance\", 6005 \"Social Networking\", game sub-genres like \"Puzzle\" (7012)... See the README for the full list.",
            "items": {
              "type": "string"
            }
          },
          "chartTypes": {
            "title": "Top Charts: chart types",
            "type": "array",
            "description": "Which charts to return for each category.",
            "items": {
              "type": "string",
              "enum": [
                "top-free",
                "top-paid"
              ],
              "enumTitles": [
                "Top Free",
                "Top Paid"
              ]
            },
            "default": [
              "top-free",
              "top-paid"
            ]
          },
          "chartPlatform": {
            "title": "Top Charts: platform",
            "enum": [
              "iphone",
              "ipad",
              "mac"
            ],
            "type": "string",
            "description": "Device charts to read.",
            "default": "iphone"
          },
          "maxChartRank": {
            "title": "Top Charts: max rank",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Return ranks 1 to N of each chart (Apple publishes up to 200). Each chart row is one billable result.",
            "default": 100
          },
          "enrichChartEntries": {
            "title": "Top Charts: full app details for every rank",
            "type": "boolean",
            "description": "Look up every charted app with the official iTunes Lookup API (price, rating count, version, size, release dates...). Without it, ranks below 25 only have the app ID.",
            "default": true
          },
          "trackRankChanges": {
            "title": "Track rank changes between runs",
            "type": "boolean",
            "description": "Saves each chart in a named key-value store (app-store-chart-history) and adds previousRank, rankChange and isNewInChart on the next run. Ideal with a daily schedule.",
            "default": true
          },
          "includeDescription": {
            "title": "Include full description",
            "type": "boolean",
            "description": "Adds the long App Store description (makes the dataset much bigger).",
            "default": false
          },
          "includeScreenshots": {
            "title": "Include screenshot URLs",
            "type": "boolean",
            "description": "Adds iPhone and iPad screenshot URLs.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "Parallel requests. Kept at 1 on purpose: Apple allows about 20 Lookup API calls per minute.",
            "default": 1
          },
          "maxRequestsPerMinute": {
            "title": "Max requests per minute",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Global rate limit (Apple's documented limit is about 20 per minute).",
            "default": 20
          },
          "delayBetweenRequestsSecs": {
            "title": "Delay before each request (seconds)",
            "minimum": 0,
            "maximum": 30,
            "type": "integer",
            "description": "Politeness delay.",
            "default": 1
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. Not needed in normal use."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}