{
  "openapi": "3.0.1",
  "info": {
    "title": "ASO Keyword Research: Keywords Any App Ranks For, iOS & Android",
    "description": "Paste an App Store id or Google Play package and get every keyword that app ranks for, with estimated volume (DataForSEO), rank, a last-checked date, an opportunity score, and a ready-to-paste iOS keyword field. Gap mode compares you with up to 5 competitors. No API key needed.",
    "version": "1.0",
    "x-build-id": "RaNG4KJR8qH7S4H0C"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/vncntlabs~aso-keyword-research/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-vncntlabs-aso-keyword-research",
        "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/vncntlabs~aso-keyword-research/runs": {
      "post": {
        "operationId": "runs-sync-vncntlabs-aso-keyword-research",
        "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/vncntlabs~aso-keyword-research/run-sync": {
      "post": {
        "operationId": "run-sync-vncntlabs-aso-keyword-research",
        "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": [
          "app"
        ],
        "properties": {
          "app": {
            "title": "Your app",
            "type": "string",
            "description": "An App Store id or URL (for example 571800810 or https://apps.apple.com/app/id571800810) or a Google Play package or URL (for example com.calm.android). The store is detected automatically when Store is set to Auto."
          },
          "store": {
            "title": "Store",
            "enum": [
              "auto",
              "app_store",
              "google_play"
            ],
            "type": "string",
            "description": "Auto-detect is usually enough. Set this only when you want to force a store.",
            "default": "auto"
          },
          "mode": {
            "title": "Mode",
            "enum": [
              "app_keywords",
              "gap",
              "discovery"
            ],
            "type": "string",
            "description": "App keywords is the default. Gap mode needs at least one competitor. Discovery lists competing apps, not keywords.",
            "default": "app_keywords"
          },
          "competitors": {
            "title": "Competitor apps",
            "type": "array",
            "description": "Up to 5 competitor App Store ids, Play packages, or store URLs. Required for gap mode. Used as an optional cap in discovery mode.",
            "items": {
              "type": "string"
            }
          },
          "limit": {
            "title": "Keyword (or competitor) limit",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many keyword rows to return (app-keywords and gap modes), or how many competitor apps to return in discovery mode. Default 100, max 1,000. The prefilled 20-keyword App Store run is sized to finish well inside 5 minutes. Gap mode always requests at least 20 keywords per competitor.",
            "default": 100
          },
          "minVolume": {
            "title": "Minimum estimated volume",
            "minimum": 0,
            "type": "integer",
            "description": "Drop keywords whose estimated volume (DataForSEO) is below this number. Default 0 (no floor).",
            "default": 0
          },
          "maxRank": {
            "title": "Maximum rank (your app)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Optional. In app-keywords mode, only keep keywords where your app ranks at or above this position (1 is the best). Leave empty to include every rank DataForSEO has, up to 100."
          },
          "competitorRankMax": {
            "title": "Maximum competitor rank (gap mode)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "In gap mode, only pull competitor keywords where they rank at or above this position. Default 20.",
            "default": 20
          },
          "liveCheckTopN": {
            "title": "Live-check the top N picks (optional)",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Optional. After scoring, live-check the top N non-flagged keywords in the App Store or Play search (DataForSEO App Data, standard queue with a 60-second priority hedge). Adds a liveRank and last-live-checked time on those rows. Default 0 (off). Each successful check is billed as a live-rank-check event. Leave at 0 for the daily prefilled test.",
            "default": 0
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}