{
  "openapi": "3.0.1",
  "info": {
    "title": "ASO Keyword Rank Tracker: iOS & Android App Positions",
    "description": "Check where an app ranks for a keyword in App Store and Google Play search, by country: rank, change since the last run, movement and the top apps for each keyword. ASO keyword rank tracker for iOS and Android apps, $2 per 1,000 checks; failed checks are free. Free plan: 5 checks per run.",
    "version": "1.0",
    "x-build-id": "WtEVLzOYBVcK1FecZ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tenfoldfleet~aso-keyword-rank-tracker-app-store-google-play/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tenfoldfleet-aso-keyword-rank-tracker-app-store-google-play",
        "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/tenfoldfleet~aso-keyword-rank-tracker-app-store-google-play/runs": {
      "post": {
        "operationId": "runs-sync-tenfoldfleet-aso-keyword-rank-tracker-app-store-google-play",
        "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/tenfoldfleet~aso-keyword-rank-tracker-app-store-google-play/run-sync": {
      "post": {
        "operationId": "run-sync-tenfoldfleet-aso-keyword-rank-tracker-app-store-google-play",
        "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": [
          "keywords"
        ],
        "properties": {
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Search phrases to check, one per line, exactly as a user would type them into App Store or Google Play search. Up to 500 keywords per run. One check = one keyword for one app in one country. Free Apify plan: the first 5 checks of a run are made; any paid plan removes the limit.",
            "items": {
              "type": "string"
            }
          },
          "iosApps": {
            "title": "App Store apps (iOS)",
            "type": "array",
            "description": "Apps to find in App Store search: the numeric App Store ID (324684580 or id324684580), an apps.apple.com URL, or a bundle ID (com.spotify.client). Up to 25 apps. An app that is not in a country's App Store is a free error item, not a charged row. Leave empty to check Google Play only.",
            "items": {
              "type": "string"
            }
          },
          "androidApps": {
            "title": "Google Play apps (Android)",
            "type": "array",
            "description": "Apps to find in Google Play search: the package name (com.spotify.music) or a play.google.com app URL. Up to 25 apps. A package that does not exist is a free error item, not a charged row. Leave empty to check the App Store only.",
            "items": {
              "type": "string"
            }
          },
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "Two-letter country codes of the stores to check, e.g. US, GB, DE, JP, BR. Rankings differ by country. Every keyword is checked for every app in every country: 10 keywords x 2 apps x 3 countries = 60 checks. Up to 25 countries.",
            "default": [
              "US"
            ],
            "items": {
              "type": "string"
            }
          },
          "language": {
            "title": "Google Play language (hl)",
            "type": "string",
            "description": "Language of the Google Play results, e.g. en, de, es, pt-BR, ja. The App Store always answers in the language of the country's store.",
            "default": "en"
          },
          "topResults": {
            "title": "Top apps per keyword",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "How many of the first apps of each search to return in topApps (rank, ID, name, developer, rating), from 0 to 50. It does not change the price.",
            "default": 10
          },
          "includeSuggestions": {
            "title": "Add App Store search suggestions",
            "type": "boolean",
            "description": "Add the App Store's autocomplete suggestions for each keyword to its App Store rows (related keywords to track next). Free. Not available for Google Play; null when the App Store gives none.",
            "default": false
          },
          "compareWithPreviousRun": {
            "title": "Compare with the previous run",
            "type": "boolean",
            "description": "Save every rank in a named key-value store in your account and report previousRank, rankChange and movement (up, down, same, new, lost) on the next run. Schedule the actor daily or weekly to track positions over time.",
            "default": true
          },
          "onlyChanges": {
            "title": "Only return positions that changed",
            "type": "boolean",
            "description": "Return and charge only the checks whose rank moved since the last run (up, down, newly ranked, lost) plus checks made for the first time. Positions that did not move are not saved and are free. Needs the rank history, so it turns the comparison on.",
            "default": false
          },
          "historyStoreName": {
            "title": "History store name",
            "type": "string",
            "description": "Name of the key-value store in your account that keeps the rank history. Use a different name for each project or client so their histories stay separate.",
            "default": "aso-rank-history"
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "The Apify datacenter proxy is used by default and is enough for both stores. A residential group is replaced by datacenter.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}