{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Play Scraper",
    "description": "Scrape Google Play apps by keyword, package name, developer or similar apps, in any country: name, developer, description, price, in-app purchases, rating, ratings by stars, installs, content rating, category, screenshots, data safety. Plus app reviews and the top free, paid and grossing charts.",
    "version": "0.1",
    "x-build-id": "BWcvDaxkqFssRW01o"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/automly~google-play-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-automly-google-play-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/automly~google-play-scraper/runs": {
      "post": {
        "operationId": "runs-sync-automly-google-play-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/automly~google-play-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-automly-google-play-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": {
          "dataType": {
            "title": "What to scrape",
            "enum": [
              "apps",
              "details",
              "charts",
              "reviews"
            ],
            "type": "string",
            "description": "Apps: one row per app found by your search terms, package names, developers and similar apps. App details: the same apps with every detail the store shows. Top charts: one row per chart place. Reviews: one row per review for the app IDs below.",
            "default": "apps"
          },
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Words to search Google Play for, e.g. photo editor or budget planner, one per line. Logged-out search returns up to about 30 apps per term and country.",
            "items": {
              "type": "string"
            }
          },
          "appIds": {
            "title": "App IDs or links",
            "type": "array",
            "description": "Google Play package names, e.g. com.spotify.music, or app links like https://play.google.com/store/apps/details?id=com.spotify.music, one per line. Used for Apps, App details and Reviews.",
            "items": {
              "type": "string"
            }
          },
          "developerIds": {
            "title": "Developers (all their apps)",
            "type": "array",
            "description": "Developer names, e.g. Spotify AB, numeric developer IDs, or developer links, to get every app they publish.",
            "items": {
              "type": "string"
            }
          },
          "similarToAppIds": {
            "title": "Find similar apps for",
            "type": "array",
            "description": "Package names or links whose \"Similar apps\" you want, e.g. com.spotify.music.",
            "items": {
              "type": "string"
            }
          },
          "searchPrice": {
            "title": "Search: price filter",
            "enum": [
              "all",
              "free",
              "paid"
            ],
            "type": "string",
            "description": "Limit keyword search results to free or paid apps. Applies to Search terms only.",
            "default": "all"
          },
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "Two-letter country codes, e.g. us, gb, de or jp. Each input is read in every country listed, and prices and availability are shown for that country.",
            "default": [
              "us"
            ],
            "items": {
              "type": "string"
            }
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Display language for names and text, e.g. en, de or pt-br.",
            "default": "en"
          },
          "chartTypes": {
            "title": "Charts",
            "type": "array",
            "description": "Which charts to get when What to scrape is Top charts.",
            "items": {
              "type": "string",
              "enum": [
                "topfree",
                "toppaid",
                "topgrossing"
              ],
              "enumTitles": [
                "Top free",
                "Top paid",
                "Top grossing"
              ]
            },
            "default": [
              "topfree"
            ]
          },
          "chartCategories": {
            "title": "Chart categories",
            "type": "array",
            "description": "Categories by their Google Play ID, e.g. APPLICATION for all apps, GAME for all games, or a specific one like GAME_PUZZLE, EDUCATION, FINANCE, PHOTOGRAPHY, SOCIAL (see the README for the full list).",
            "default": [
              "APPLICATION"
            ],
            "items": {
              "type": "string"
            }
          },
          "reviewsSort": {
            "title": "Sort reviews by",
            "enum": [
              "newest",
              "rating",
              "relevance"
            ],
            "type": "string",
            "description": "The order reviews are read in, when What to scrape is Reviews.",
            "default": "newest"
          },
          "reviewsStars": {
            "title": "Only this star rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Read only reviews with this star rating (1-5). Leave empty for all reviews."
          },
          "maxReviewsPerApp": {
            "title": "Max reviews per app",
            "minimum": 0,
            "type": "integer",
            "description": "The most reviews to read per app. Leave empty or 0 for no per-app limit (the run-wide Max results still applies)."
          },
          "includeDataSafety": {
            "title": "Include data safety",
            "type": "boolean",
            "description": "In App details runs, also read each app's Data safety section (data shared and collected). Adds one more page per app.",
            "default": false
          },
          "includePermissions": {
            "title": "Include permissions",
            "type": "boolean",
            "description": "In App details runs, also read each app's requested permissions.",
            "default": false
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 0,
            "maximum": 10000000,
            "type": "integer",
            "description": "The most rows this run saves, across all inputs and countries. Set 0 for no limit.",
            "default": 100
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "The default works for most runs. If results come back empty, try a different proxy option.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}