openapi: 3.2.0
info:
  title: AppstoreSpy Google Play API
  description: "# Authentication\n\nThe Appstorespy API uses API-KEY authentication.<br>\n\nIf you do not have an API Key token, you can get it on your account page [https://appstorespy.com/account](https://appstorespy.com/account). <br>\n\nAn API Key is required to be sent as part of every request in request header.\n\n```\n\n    -H 'accept: application/json'\n\n    -H 'API-KEY: <your_token>'\n\n```\n\n\n\n# Fields\n\nUse the fields parameter to specify which fields should be returned. <br>\n\nExample:\n\n```\n\n    Request: fields=name,developer_name,ipd,downloads,...\n\n    Response: {name: ..., developer_name: ..., ipd: ..., downloads: ..., ...}\n\n```\n\nDon`t use fields parameter if you need to get all fields. <br>\n\n\n\n\n\n# Sort\n\nWhen you use search, you can add a sort parameter.\n\n```\n\n    Request: sort=ratingCount\n\n    Response: [{name: app1, ratingCount: 4.2}, {name: app2, ratingCount: 4.4}, ...]\n\n```\n\nIf you need DESC sorting add \"-\" before sort parametr.\n\n```\n\n    Request: sort=-ratingCount\n\n    Response: [{name: app2, ratingCount: 4.4}, {name: app1, ratingCount: 4.2}, ...]\n\n```\n\n\n\n# County & Language params\n\n...\n\n\n\n# Status codes / Error codes\n\n* 200 OK.\n\n* 202 Accepted - The app was not present in our databases and has been submitted for crawling. If the app is available anywhere, it will be available soon.\n\n* 204 No Content - No data for requested country.\n\n* 403 Forbidden - Your access token is not valid.\n\n* 429 Too Many Requests - Your request rate is over the limit.\n"
  version: 0.0.1
servers:
- url: https://api.appstorespy.com/v1
tags:
- name: Google Play
paths:
  /play/apps:
    get:
      tags:
      - Google Play
      summary: Search Google Play apps by query.
      operationId: get_app_search_play_apps_get
      parameters:
      - description: Word or phrase for search.
        required: false
        schema:
          type: string
          title: Q
          description: Word or phrase for search.
        example: X
        name: q
        in: query
      - description: Empty for all.
        required: false
        schema:
          type: boolean
          title: Published
          description: Empty for all.
        name: published
        in: query
      - description: Country for specific country fields. Default - US.
        required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/AppCountries'
          description: Country for specific country fields. Default - US.
        name: country
        in: query
      - description: 'Language of meta data. By default: store default language.'
        required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/AppLanguages'
          description: 'Language of meta data. By default: store default language.'
        name: language
        in: query
      - description: Fields to return separated by comma(,)
        required: false
        schema:
          type: string
          title: Fields
          description: Fields to return separated by comma(,)
        name: fields
        in: query
      - description: Sort params separated by comma(,)
        required: false
        schema:
          type: string
          title: Sort
          description: Sort params separated by comma(,)
        example: -installs_exact,-revenue
        name: sort
        in: query
      - description: Count per page
        required: false
        schema:
          type: integer
          maximum: 1000.0
          title: Limit
          description: Count per page
          default: 10
        name: limit
        in: query
      - description: Page
        required: false
        schema:
          type: integer
          title: Page
          description: Page
          default: 1
        name: page
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PlayApp'
                type: array
                title: Response Get App Search Play Apps Get
            text/csv: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/apps/{id}/reviews:
    get:
      tags:
      - Google Play
      summary: Get Google Play app reviews by app ID.
      operationId: get_reviews_play_apps__id__reviews_get
      parameters:
      - description: App ID(bundle)
        required: true
        schema:
          type: string
          title: Id
          description: App ID(bundle)
        example: com.twitter.android
        name: id
        in: path
      - required: false
        schema:
          $ref: '#/components/schemas/AppCountries'
        name: country
        in: query
      - description: Review language
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/AppLanguages'
          description: Review language
        name: language
        in: query
      - description: Count of reviews per page
        required: false
        schema:
          type: integer
          maximum: 1000.0
          title: Limit
          description: Count of reviews per page
          default: 10
        name: limit
        in: query
      - description: Sort params separated by comma(,)
        required: false
        schema:
          type: string
          title: Sort
          description: Sort params separated by comma(,)
        example: stars,-likes
        name: sort
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PlayReview'
                type: array
                title: Response Get Reviews Play Apps  Id  Reviews Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/apps/{id}/recrawl:
    get:
      tags:
      - Google Play
      summary: Get Recrawl
      operationId: get_recrawl_play_apps__id__recrawl_get
      parameters:
      - description: App ID(bundle)
        required: true
        schema:
          type: string
          title: Id
          description: App ID(bundle)
        example: com.twitter.android
        name: id
        in: path
      - description: 'Country for which return data. By default: US.'
        required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/AppCountries'
          description: 'Country for which return data. By default: US.'
          default: US
        name: country
        in: query
      - description: 'Language of meta data. By default: en_US'
        required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/AppLanguages'
          description: 'Language of meta data. By default: en_US'
          default: en_US
        name: language
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/apps/query:
    post:
      tags:
      - Google Play
      summary: Get Filter Search
      operationId: get_filter_search_play_apps_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlayAppSearchBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlayAppListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/apps/similar:
    post:
      tags:
      - Google Play
      summary: Get Similar
      operationId: get_similar_play_apps_similar_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimilarSearchBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlayAppListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/apps/summary:
    post:
      tags:
      - Google Play
      summary: Get Summary
      operationId: get_summary_play_apps_summary_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SummarySearchBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SummaryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/apps/{id}:
    get:
      tags:
      - Google Play
      summary: Get Google Play app by ID.
      operationId: get_app_details_play_apps__id__get
      parameters:
      - description: App ID(bundle)
        required: true
        schema:
          type: string
          title: Id
          description: App ID(bundle)
        example: com.twitter.android
        name: id
        in: path
      - description: Fields to return separated by comma(,)
        required: false
        schema:
          type: string
          title: Fields
          description: Fields to return separated by comma(,)
        name: fields
        in: query
      - description: 'Country for which return data. By default: US.'
        required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/AppCountries'
          description: 'Country for which return data. By default: US.'
        name: country
        in: query
      - description: 'Language of meta data. By default: store default language.'
        required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/AppLanguages'
          description: 'Language of meta data. By default: store default language.'
        name: language
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlayApp'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/info/countries:
    get:
      tags:
      - Google Play
      summary: Get Google Play app available countries.
      description: This query returns the list of Google Play app available countries.
      operationId: get_play_app_countries_play_info_countries_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreCountries'
      security:
      - APIKeyHeader: []
  /play/info/languages:
    get:
      tags:
      - Google Play
      summary: Get Google Play app available languages.
      description: This query returns the list of Google Play app available languages.
      operationId: get_play_app_languages_play_info_languages_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreLanguages'
      security:
      - APIKeyHeader: []
  /play/developers/{id}:
    get:
      tags:
      - Google Play
      summary: Get Developer
      operationId: get_developer_play_developers__id__get
      parameters:
      - description: Developer ID
        required: true
        schema:
          type: string
          title: Id
          description: Developer ID
        example: '6891936352065498609'
        name: id
        in: path
      - description: Fields to return separated by comma(,)
        required: false
        schema:
          type: string
          title: Fields
          description: Fields to return separated by comma(,)
        name: fields
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlayDev'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/developers:
    get:
      tags:
      - Google Play
      summary: Dev Search
      operationId: dev_search_play_developers_get
      parameters:
      - description: Query for search
        required: false
        schema:
          type: string
          title: Q
          description: Query for search
        example: hq_country:US
        name: q
        in: query
      - description: Fields to return separated by comma(,)
        required: false
        schema:
          type: string
          title: Fields
          description: Fields to return separated by comma(,)
        name: fields
        in: query
      - description: Sort params separated by comma(,)
        required: false
        schema:
          type: string
          title: Sort
          description: Sort params separated by comma(,)
        example: -total_apps,-installs
        name: sort
        in: query
      - description: Count per page
        required: false
        schema:
          type: integer
          maximum: 1000.0
          title: Limit
          description: Count per page
          default: 10
        name: limit
        in: query
      - description: Page
        required: false
        schema:
          type: integer
          title: Page
          description: Page
          default: 1
        name: page
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PlayDev'
                type: array
                title: Response Dev Search Play Developers Get
            text/csv: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/developers/{id}/estimates:
    get:
      tags:
      - Google Play
      summary: Get Apps Estimates
      description: Get Google Play apps estimates
      operationId: get_apps_estimates_play_developers__id__estimates_get
      parameters:
      - description: Developer's id
        required: true
        schema:
          type: string
          title: Id
          description: Developer's id
        example: '7022973042396704692'
        name: id
        in: path
      - description: Start date. Format YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
          title: Start
          description: Start date. Format YYYY-MM-DD
        name: start
        in: query
      - description: Start date. Format YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
          title: End
          description: Start date. Format YYYY-MM-DD
        name: end
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/DevAppsEstimates'
                type: array
                title: Response Get Apps Estimates Play Developers  Id  Estimates Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/estimates:
    get:
      tags:
      - Google Play
      summary: Get Apps Estimates
      description: Get Google Play apps estimates
      operationId: get_apps_estimates_play_estimates_get
      parameters:
      - description: Apps to return separated by comma(,)
        required: true
        schema:
          type: string
          title: Id
          description: Apps to return separated by comma(,)
        example: com.twitter.android
        name: id
        in: query
      - description: Start date. Format YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
          title: Start
          description: Start date. Format YYYY-MM-DD
        name: start
        in: query
      - description: Start date. Format YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
          title: End
          description: Start date. Format YYYY-MM-DD
        name: end
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AppsEstimates'
                type: array
                title: Response Get Apps Estimates Play Estimates Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/apps/{id}/installs_daily:
    get:
      tags:
      - Google Play
      summary: Get Apps Installs Daily
      description: 'Get Google Play apps daily installs.


        `ipd` is derived from the cumulative install total: each increase is spread evenly across the elapsed days since the total last changed, so collection gaps and lagging reports are amortised rather than reported as a single-day spike. Values are raw and never negative.


        Note: these are unsmoothed figures. AppstoreSpy''s own charts additionally apply a moving average for readability, so a given day''s value may differ from what the UI plots. This endpoint is the underlying data.'
      operationId: get_apps_installs_daily_play_apps__id__installs_daily_get
      parameters:
      - description: Apps to return separated by comma(,)
        required: true
        schema:
          type: string
          title: Id
          description: Apps to return separated by comma(,)
        example: com.twitter.android
        name: id
        in: path
      - description: Start date. Format YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
          title: Start
          description: Start date. Format YYYY-MM-DD
        name: start
        in: query
      - description: Start date. Format YYYY-MM-DD
        required: false
        schema:
          type: string
          format: date
          title: End
          description: Start date. Format YYYY-MM-DD
        name: end
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AppsDailyInstalls'
                type: array
                title: Response Get Apps Installs Daily Play Apps  Id  Installs Daily Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/suggestions:
    get:
      tags:
      - Google Play
      summary: Get Suggests
      operationId: get_suggests_play_suggestions_get
      parameters:
      - required: true
        schema:
          type: string
          title: Q
        name: q
        in: query
      - required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/AppCountries'
          default: US
        name: country
        in: query
      - required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/AppLanguages'
          default: en_US
        name: lang
        in: query
      - required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/CacheTime'
          default: 7d
        name: freshness
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Suggest'
        '202':
          description: Response in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuggestLite'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/liveops:
    get:
      tags:
      - Google Play
      summary: Get Events
      operationId: get_events_play_liveops_get
      parameters:
      - required: true
        schema:
          type: string
          title: App
        name: app
        in: query
      - required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/AppCountries'
          default: US
        name: country
        in: query
      - required: false
        schema:
          allOf:
          - $ref: '#/components/schemas/CacheTime'
          default: 7d
        name: freshness
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Event'
                type: array
                title: Response 200 Get Events Play Liveops Get
        '202':
          description: Response in progress
          content:
            application/json: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /play/rankings:
    get:
      tags:
      - Google Play
      summary: Get Google Play rankings data
      operationId: get_play_rankings_play_rankings_get
      parameters:
      - description: Start date (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          title: Date Start
          description: Start date (YYYY-MM-DD)
        name: date_start
        in: query
      - description: End date (YYYY-MM-DD)
        required: false
        schema:
          type: string
          format: date
          title: Date End
          description: End date (YYYY-MM-DD)
        name: date_end
        in: query
      - description: App IDs (comma-separated)
        required: false
        schema:
          items:
            type: string
          type: array
          title: App
          description: App IDs (comma-separated)
        name: app
        in: query
      - description: Country codes (comma-separated)
        required: false
        schema:
          items:
            $ref: '#/components/schemas/AppCountries'
          type: array
          description: Country codes (comma-separated)
        name: country
        in: query
      - description: App categories (comma-separated)
        required: false
        schema:
          items:
            $ref: '#/components/schemas/PlayCategory'
          type: array
          description: App categories (comma-separated)
        name: category
        in: query
      - description: Collection types (comma-separated)
        required: false
        schema:
          items:
            $ref: '#/components/schemas/Collection'
          type: array
          description: Collection types (comma-separated)
        name: collection
        in: query
      - description: Minimum rank
        required: false
        schema:
          type: integer
          minimum: 1.0
          title: Rank Start
          description: Minimum rank
        name: rank_start
        in: query
      - description: Maximum rank
        required: false
        schema:
          type: integer
          maximum: 10000.0
          title: Rank End
          description: Maximum rank
        name: rank_end
        in: query
      - description: Count per page
        required: false
        schema:
          type: integer
          maximum: 1000.0
          title: Limit
          description: Count per page
          default: 10
        name: limit
        in: query
      - description: Page
        required: false
        schema:
          type: integer
          title: Page
          description: Page
          default: 1
        name: page
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_list_models.responses.response.PlayRankingItem__'
            text/csv: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
components:
  schemas:
    StoreLanguages:
      properties:
        languages:
          items:
            type: string
          type: array
          title: Languages
      type: object
      required:
      - languages
      title: StoreLanguages
    AppsEstimates:
      properties:
        id:
          type: string
          title: Id
        month:
          type: string
          title: Month
        downloads:
          type: integer
          title: Downloads
        revenue:
          type: integer
          title: Revenue
      type: object
      required:
      - id
      - month
      title: AppsEstimates
    PlayCategory:
      enum:
      - APPLICATION
      - SOCIAL
      - FAMILY
      - ANDROID_WEAR
      - ART_AND_DESIGN
      - AUTO_AND_VEHICLES
      - BEAUTY
      - BOOKS_AND_REFERENCE
      - BUSINESS
      - COMICS
      - COMMUNICATION
      - DATING
      - EDUCATION
      - ENTERTAINMENT
      - EVENTS
      - FINANCE
      - FOOD_AND_DRINK
      - HEALTH_AND_FITNESS
      - HOUSE_AND_HOME
      - LIBRARIES_AND_DEMO
      - LIFESTYLE
      - MAPS_AND_NAVIGATION
      - MEDICAL
      - MUSIC_AND_AUDIO
      - NEWS_AND_MAGAZINES
      - PARENTING
      - PERSONALIZATION
      - PHOTOGRAPHY
      - PRODUCTIVITY
      - SHOPPING
      - SPORTS
      - TOOLS
      - TRAVEL_AND_LOCAL
      - VIDEO_PLAYERS
      - WEATHER
      - GAME
      - GAME_ACTION
      - GAME_ADVENTURE
      - GAME_ARCADE
      - GAME_BOARD
      - GAME_CARD
      - GAME_CASINO
      - GAME_CASUAL
      - GAME_EDUCATIONAL
      - GAME_MUSIC
      - GAME_PUZZLE
      - GAME_RACING
      - GAME_ROLE_PLAYING
      - GAME_SIMULATION
      - GAME_SPORTS
      - GAME_STRATEGY
      - GAME_TRIVIA
      - GAME_WORD
      - FAMILY_ACTION
      - FAMILY_BRAINGAMES
      - FAMILY_CREATE
      - FAMILY_MUSICVIDEO
      - FAMILY_PRETEND
      - FAMILY_EDUCATION
      title: PlayCategory
      description: An enumeration.
    ValueRange:
      properties:
        lte:
          anyOf:
          - type: integer
          - type: number
          title: Lte
        gte:
          anyOf:
          - type: integer
          - type: number
          title: Gte
      type: object
      title: ValueRange
    AppLanguages:
      type: string
      enum:
      - en_US
      - ar
      - en_GB
      - fr_FR
      - es_419
      - de_DE
      - pt_BR
      - it_IT
      - ja_JP
      - ko_KR
      - tr_TR
      - ru_RU
      - vi
      title: AppLanguages
      description: An enumeration.
    TypeEnum:
      enum:
      - APP
      - GAME
      title: TypeEnum
      description: An enumeration.
    PlayAppSearchBody:
      properties:
        limit:
          type: integer
          title: Limit
          description: Count of apps in results
          default: 10
        page:
          type: integer
          title: Page
          description: Offset page
          default: 1
        sort:
          allOf:
          - $ref: '#/components/schemas/PlaySortEnum'
          description: Field for sort
        fields:
          items:
            type: string
          type: array
          title: Fields
          description: Fields for select, empty for all
          default:
          - id
          - url_appstorespy
          - name
          - bundle
          - description_full
          - published
          - listing_visible
          - category
          - category_type
          - revenue_month
          - revenue_lifetime
          - downloads_month
          - downloads_lifetime
          - update_date
          - release_date
          - developer_name
          - description_short
          - whatsnew
          - icon
          - video
          - screenshots
          - feature_graphic
          - removal_date
          - version
          - size
          - downloads_exact
          - downloads_mark
          - rating_count
          - rating_value
          - review_count
          - rating_avg
          - iap
          - editorial
          - hosts
          - chart_info
          - country
          - advertised
          - ads
        country:
          allOf:
          - $ref: '#/components/schemas/AppCountries'
          description: Country for which return data
          default: US
        language:
          allOf:
          - $ref: '#/components/schemas/AppLanguages'
          description: 'Language of meta data. By default: en_US'
        filter:
          $ref: '#/components/schemas/SearchFilterPlay'
      type: object
      required:
      - filter
      title: PlayAppSearchBody
      example:
        sort: -downloads_daily
        fields:
        - id
        - name
        - icon
        - video
        - downloads_mark
        - category_type
        - category
        - url_appstorespy
        language: en_US
        filter:
          name: twitter
          bundle:
          - com.twitter.android
          - com.facebook.katana
          published: true
          category_type: APP
          release_date:
            lte: '2026-08-22'
          update_date:
            lte: '2026-08-22'
          rating_avg:
            lte: 5.0
            gte: 3.0
          rating_count:
            lte: 1000000
            gte: 0
          active_countries:
          - US
          downloads_daily:
            lte: 100000
            gte: 0
          downloads_exact:
            lte: 1000000
            gte: 0
    DevAppsEstimates:
      properties:
        month:
          type: string
          title: Month
        downloads:
          type: integer
          title: Downloads
        revenue:
          type: integer
          title: Revenue
      type: object
      required:
      - month
      title: DevAppsEstimates
    Image:
      properties:
        url:
          type: string
          title: Url
      type: object
      title: Image
    SimilarSearchBody:
      properties:
        limit:
          type: integer
          title: Limit
          description: Count of apps in results
          default: 10
        page:
          type: integer
          title: Page
          description: Offset page
          default: 1
        sort:
          allOf:
          - $ref: '#/components/schemas/PlaySortEnum'
          description: Field for sort
        fields:
          items:
            type: string
          type: array
          title: Fields
          description: Fields for select, empty for all
          default:
          - id
          - url_appstorespy
          - name
          - bundle
          - description_full
          - published
          - listing_visible
          - category
          - category_type
          - revenue_month
          - revenue_lifetime
          - downloads_month
          - downloads_lifetime
          - update_date
          - release_date
          - developer_name
          - description_short
          - whatsnew
          - icon
          - video
          - screenshots
          - feature_graphic
          - removal_date
          - version
          - size
          - downloads_exact
          - downloads_mark
          - rating_count
          - rating_value
          - review_count
          - rating_avg
          - iap
          - editorial
          - hosts
          - chart_info
          - country
          - advertised
          - ads
        country:
          allOf:
          - $ref: '#/components/schemas/AppCountries'
          description: Country for which return data
          default: US
        language:
          allOf:
          - $ref: '#/components/schemas/AppLanguages'
          description: 'Language of meta data. By default: en_US'
        filter:
          $ref: '#/components/schemas/SearchFilterPlay'
        id:
          type: string
          title: Id
        link:
          $ref: '#/components/schemas/SimilarEnum'
      type: object
      required:
      - filter
      - id
      - link
      title: SimilarSearchBody
      example:
        id: com.twitter.android
        link: from
        filter:
          published: true
        sort: -downloads_daily
        fields:
        - id
        - name
        - icon
        - video
        - downloads_mark
        - category_type
        - category
        - url_appstorespy
        language: en_US
    PlayApp:
      properties:
        id:
          type: string
          title: Id
          description: The app package name
        bundle:
          type: string
          title: Bundle
          description: Bundle(the same as id)
        published:
          type: boolean
          title: Published
          description: Published
        available_in:
          items: {}
          type: array
          title: Available In
          description: Available in countries
        available_not:
          items: {}
          type: array
          title: Available Not
          description: Not available in countries
        country:
          type: string
          title: Country
          description: Country for which specific fields returned
        lang:
          type: string
          title: Lang
          description: The language in which the app metadata is returned
        languages:
          items: {}
          type: array
          title: Languages
          description: Translations detected by AppstoreSpy
        type:
          type: string
          title: Type
          description: 'Category type: app or game'
        category:
          type: string
          title: Category
          description: Category ID. Refer to the Google Play categories for more information
        name:
          type: string
          title: Name
          description: Name in the specified language
        short:
          type: string
          title: Short
          description: Short description in the specified language
        description:
          type: string
          title: Description
          description: Description in the specified language
        icon:
          type: string
          title: Icon
          description: Icon in the specified language
        screenshots:
          items:
            type: string
          type: array
          title: Screenshots
          description: Screenshots in the specified language
        trailer:
          type: string
          title: Trailer
          description: Video trailer Youtube link in the specified language
        feature:
          type: string
          title: Feature
          description: Feature in the specified language
        whatsnew:
          type: string
          title: Whatsnew
          description: What's new in the specified language
        developer_id:
          type: string
          title: Developer Id
          description: Developer ID
        developer_name:
          type: string
          title: Developer Name
          description: Developer name
        emails:
          items:
            type: string
          type: array
          title: Emails
          description: Contact email
        website:
          type: string
          title: Website
          description: Website
        privacy_policy:
          type: string
          title: Privacy Policy
          description: Privacy policy link
        url:
          type: string
          title: Url
          description: Link to Google Play
        editorial:
          type: boolean
          title: Editorial
          description: Editor's choice
        iap:
          type: boolean
          title: Iap
          description: App offers in-app purchases
        ads:
          allOf:
          - $ref: '#/components/schemas/Creatives'
          title: Ads
          description: App`s ads
        advertised:
          type: boolean
          title: Advertised
          description: App is advertised in networks
        installs:
          type: string
          title: Installs
          description: Installs checkpoint
        installs_exact:
          type: integer
          title: Installs Exact
          description: Accurate installs value
        ipd:
          type: integer
          title: Ipd
          description: Estimated daily installs
        rating_count:
          type: integer
          title: Rating Count
          description: Total ratings
        rating_value:
          type: number
          title: Rating Value
          description: Rating value in the specified country
        review_count:
          type: integer
          title: Review Count
          description: Number of reviews in the specified country
        rating_avg:
          type: number
          title: Rating Avg
          description: Weighted average Rating value
        review_total:
          type: number
          title: Review Total
          description: Total reviews as detected by AppstoreSpy
        revenue:
          type: integer
          title: Revenue
        downloads:
          type: integer
          title: Downloads
        version:
          type: string
          title: Version
          description: App version, optional if app has multiple versions
        size:
          type: integer
          title: Size
          description: App size in bytes, optional if app has multiple versions
        updated:
          type: string
          title: Updated
          description: The last time the app was updated on Google Play
        released:
          type: string
          title: Released
          description: The release date as detected by AppstoreSpy
        age:
          type: integer
          title: Age
          description: Age in days as detected by AppstoreSpy
        removed:
          type: string
          title: Removed
          description: The removal date as detected by AppstoreSpy
        crawled:
          type: string
          title: Crawled
          description: The last crawled time by AppstoreSpy
        top_countries_revenue:
          items:
            type: string
          type: array
          title: Top Countries Revenue
          description: Top 5 revenue country
        top_countries_downloads:
          items:
            type: string
          type: array
          title: Top Countries Downloads
          description: Top 5 downloads country
        hosts:
          items:
            type: string
          type: array
          title: Hosts
          description: Hosts
        countries_list:
          items:
            type: string
          type: array
          title: Countries List
          description: countries
        url_appstorespy:
          type: string
          title: Url Appstorespy
          description: Url to AppstoreSpy
        transferred:
          type: string
          title: Transferred
          description: The last transfer date as detected by AppstoreSpy
        previous_developer_id:
          type: string
          title: Previous Developer Id
          description: Previous developer ID before transfer
        previous_developer_name:
          type: string
          title: Previous Developer Name
          description: Previous developer name before transfer
        about_phone:
          type: string
          title: About Phone
          description: 'About developer: phone number'
        about_address:
          type: string
          title: About Address
          description: 'About developer: address'
        support_phone:
          type: string
          title: Support Phone
          description: 'App support: phone number'
        address_country:
          type: string
          title: Address Country
          description: 'Address: country'
      type: object
      title: PlayApp
    PlayRankingItem:
      properties:
        date:
          type: string
          title: Date
        app:
          type: string
          title: App
        country:
          type: string
          title: Country
        category:
          type: string
          title: Category
        collection:
          type: string
          title: Collection
        rank:
          type: integer
          title: Rank
      type: object
      required:
      - date
      - app
      - country
      - category
      - collection
      - rank
      title: PlayRankingItem
    PlayDev:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        category:
          type: string
          title: Category
        type:
          type: string
          title: Type
        total_apps:
          type: integer
          title: Total Apps
        published_apps:
          type: integer
          title: Published Apps
        last_updated:
          type: string
          title: Last Updated
        first_released:
          type: string
          title: First Released
        rating_count:
          type: integer
          title: Rating Count
        downloads:
          type: integer
          title: Downloads
        revenue:
          type: integer
          title: Revenue
        top_apps:
          items:
            type: string
          type: array
          title: Top Apps
        hq_country:
          type: string
          title: Hq Country
        email:
          items:
            type: string
          type: array
          title: Email
        url:
          type: string
          title: Url
        installs:
          type: integer
          title: Installs
        installs_exact:
          type: integer
          title: Installs Exact
        ipd:
          type: integer
          title: Ipd
        ipd_max:
          type: integer
          title: Ipd Max
        icon:
          type: string
          title: Icon
        header:
          type: string
          title: Header
        featured:
          type: string
          title: Featured
      type: object
      title: PlayDev
    PlayChart:
      properties:
        position:
          type: integer
          title: Position
        collection:
          type: string
          title: Collection
        category:
          type: string
          title: Category
      type: object
      required:
      - position
      - collection
      - category
      title: PlayChart
    Collection:
      enum:
      - Free
      - Grossing
      - Paid
      - topselling_free
      - topgrossing
      - topselling_paid
      - topselling_new_free
      - topselling_new_paid
      - movers_shakers
      title: Collection
      description: An enumeration.
    AppCreativeVideo:
      properties:
        preview:
          type: string
          title: Preview
        video:
          type: string
          title: Video
        url:
          type: string
          title: Url
      type: object
      title: AppCreativeVideo
    Creatives:
      properties:
        video:
          $ref: '#/components/schemas/AppCreativeVideo'
        image:
          $ref: '#/components/schemas/Image'
        fb:
          items:
            type: string
          type: array
          title: Fb
        network:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          title: Network
      type: object
      required:
      - video
      - image
      - fb
      - network
      title: Creatives
    PlayAppListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/NewPlayApp'
          type: array
          title: Data
        errors:
          items:
            $ref: '#/components/schemas/DetailedError'
          type: array
          title: Errors
        total_count:
          type: integer
          title: Total Count
          default: 0
      type: object
      title: PlayAppListResponse
    NewPlayApp:
      properties:
        id:
          type: string
          title: Id
        country:
          type: string
          title: Country
        language:
          type: string
          title: Language
        bundle:
          type: string
          title: Bundle
        name:
          type: string
          title: Name
        description_full:
          type: string
          title: Description Full
        published:
          type: boolean
          title: Published
        listing_visible:
          type: boolean
          title: Listing Visible
        category:
          type: string
          title: Category
        category_type:
          type: string
          title: Category Type
        revenue_month:
          type: integer
          title: Revenue Month
        revenue_lifetime:
          type: integer
          title: Revenue Lifetime
        downloads_month:
          type: integer
          title: Downloads Month
        downloads_lifetime:
          type: integer
          title: Downloads Lifetime
        release_date:
          type: string
          format: date
          title: Release Date
        update_date:
          type: string
          format: date
          title: Update Date
        developer_name:
          type: string
          title: Developer Name
        description_short:
          type: string
          title: Description Short
        whatsnew:
          type: string
          title: Whatsnew
        icon:
          type: string
          title: Icon
        video:
          type: string
          title: Video
        screenshots:
          items:
            type: string
          type: array
          title: Screenshots
        feature_graphic:
          type: string
          title: Feature Graphic
        removal_date:
          type: string
          format: date
          title: Removal Date
        version:
          type: string
          title: Version
        size:
          type: number
          title: Size
        downloads_daily:
          type: integer
          title: Downloads Daily
        downloads_exact:
          type: integer
          title: Downloads Exact
        downloads_mark:
          type: integer
          title: Downloads Mark
        rating_count:
          type: integer
          title: Rating Count
        rating_value:
          type: number
          title: Rating Value
        review_count:
          type: integer
          title: Review Count
        rating_avg:
          type: number
          title: Rating Avg
        iap:
          type: boolean
          title: Iap
        editorial:
          type: boolean
          title: Editorial
        chart_info:
          $ref: '#/components/schemas/PlayChart'
        hosts:
          items:
            type: string
          type: array
          title: Hosts
        url_appstorespy:
          type: string
          title: Url Appstorespy
          description: Url to AppstoreSpy
        ipd:
          type: integer
          title: Ipd
          description: Estimated daily installs
        email:
          items:
            type: string
          type: array
          title: Email
          description: App's developer email
        url:
          type: string
          title: Url
          description: Link to App Store
        policy:
          type: string
          title: Policy
          description: '...'
        website:
          type: string
          title: Website
          description: App website
        developer_id:
          type: string
          title: Developer Id
        ads:
          allOf:
          - $ref: '#/components/schemas/Creatives'
          title: Ads
          description: App`s ads
        advertised:
          type: boolean
          title: Advertised
          description: App is advertised in networks
        about_phone:
          type: string
          title: About Phone
          description: 'About developer: phone number'
        about_address:
          type: string
          title: About Address
          description: 'About developer: address'
        address_country:
          type: string
          title: Address Country
          description: 'Address: country'
        support_phone:
          type: string
          title: Support Phone
          description: 'App support: phone number'
        transferred:
          type: string
          title: Transferred
          description: The last transfer date as detected by AppstoreSpy
        previous_developer_id:
          type: string
          title: Previous Developer Id
          description: Previous developer ID before transfer
        previous_developer_name:
          type: string
          title: Previous Developer Name
          description: Previous developer name before transfer
      type: object
      required:
      - id
      - country
      - language
      title: NewPlayApp
    ApiResponse_list_models.responses.response.PlayRankingItem__:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PlayRankingItem'
          type: array
          title: Data
        errors:
          items:
            $ref: '#/components/schemas/DetailedError'
          type: array
          title: Errors
        total_count:
          type: integer
          title: Total Count
          default: 0
      type: object
      title: ApiResponse[list[models.responses.response.PlayRankingItem]]
    SimilarEnum:
      enum:
      - to
      - from
      title: SimilarEnum
      description: An enumeration.
    StoreCountries:
      properties:
        countries:
          items:
            type: string
          type: array
          title: Countries
      type: object
      required:
      - countries
      title: StoreCountries
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChartFilterPlay:
      properties:
        collection:
          $ref: '#/components/schemas/Collection'
        country:
          type: string
          title: Country
        date:
          type: string
          title: Date
        category:
          $ref: '#/components/schemas/PlayCategory'
      type: object
      required:
      - country
      - category
      title: ChartFilterPlay
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DateRange:
      properties:
        lte:
          type: string
          format: date
          title: Lte
        gte:
          type: string
          format: date
          title: Gte
      type: object
      title: DateRange
    AppCountries:
      type: string
      enum:
      - US
      - CA
      - AT
      - BE
      - CY
      - CZ
      - DK
      - FI
      - FR
      - DE
      - GR
      - HU
      - IE
      - IT
      - NL
      - 'NO'
      - PL
      - PT
      - RU
      - ES
      - SE
      - CH
      - TR
      - UA
      - GB
      - EG
      - IN
      - IL
      - MA
      - NG
      - SA
      - ZA
      - AE
      - AU
      - HK
      - ID
      - JP
      - KZ
      - KR
      - MY
      - NZ
      - PK
      - PH
      - SG
      - TW
      - TH
      - VN
      - AR
      - BR
      - MX
      title: AppCountries
      description: An enumeration.
    SuggestLite:
      properties:
        id:
          type: string
          title: Id
        term:
          type: string
          title: Term
        country:
          type: string
          title: Country
        added:
          type: string
          format: date-time
          title: Added
        lang:
          type: string
          title: Lang
        store:
          type: string
          title: Store
      type: object
      required:
      - id
      - term
      - country
      - added
      - lang
      - store
      title: SuggestLite
    SummaryResponse:
      properties:
        total:
          type: integer
          title: Total
        ipd:
          type: integer
          title: Ipd
        revenue:
          type: integer
          title: Revenue
        downloads:
          type: integer
          title: Downloads
        available:
          type: integer
          title: Available
        removed:
          type: integer
          title: Removed
      type: object
      required:
      - total
      - ipd
      - revenue
      - downloads
      - available
      - removed
      title: SummaryResponse
    AppsDailyInstalls:
      properties:
        id:
          type: string
          title: Id
        date:
          type: string
          format: date
          title: Date
        ipd:
          type: integer
          title: Ipd
        installs:
          type: integer
          title: Installs
      type: object
      required:
      - id
      - date
      - ipd
      title: AppsDailyInstalls
    Event:
      properties:
        id:
          type: string
          title: Id
        app:
          type: string
          title: App
        store:
          type: string
          title: Store
        type:
          type: string
          title: Type
        title:
          type: string
          title: Title
        text:
          type: string
          title: Text
        image:
          type: string
          title: Image
        country:
          type: string
          title: Country
        state:
          type: string
          title: State
        crawled:
          type: string
          format: date-time
          title: Crawled
        date_from:
          type: string
          format: date-time
          title: Date From
        date_to:
          type: string
          format: date-time
          title: Date To
        video:
          type: string
          title: Video
      type: object
      required:
      - id
      - app
      - store
      - type
      - title
      - text
      - image
      - country
      - state
      - crawled
      - date_from
      title: Event
    DetailedError:
      properties:
        location:
          type: string
          title: Location
        message:
          type: string
          title: Message
        value:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          title: Value
      type: object
      required:
      - location
      - message
      title: DetailedError
    PlaySortEnum:
      type: string
      enum:
      - revenue_month
      - -revenue_month
      - downloads_month
      - -downloads_month
      - update_date
      - -update_date
      - release_date
      - -release_date
      - removal_date
      - -removal_date
      - downloads_exact
      - -downloads_exact
      - downloads_mark
      - -downloads_mark
      - rating_count
      - -rating_count
      - rating_value
      - -rating_value
      - review_count
      - -review_count
      - rating_avg
      - -rating_avg
      - chart_info
      - -chart_info
      - downloads_daily
      - -downloads_daily
      title: PlaySortEnum
      description: An enumeration.
    PlayReview:
      properties:
        id:
          type: string
          title: Id
          description: Review ID
        lang:
          type: string
          title: Lang
          description: Review language
        author_id:
          type: string
          title: Author Id
          description: ID of the review author
        author_name:
          type: string
          title: Author Name
          description: Name of the review author
        author_image:
          type: string
          title: Author Image
          description: Image URL of the review author
        version:
          type: string
          title: Version
          description: App version
        created:
          type: string
          title: Created
          description: Creation date
        stars:
          type: integer
          title: Stars
          description: App rating
        likes:
          type: integer
          title: Likes
          description: Review likes
        comment:
          type: string
          title: Comment
          description: Review text
        reply:
          type: string
          title: Reply
          description: Reply text
        replied:
          type: string
          title: Replied
          description: Reply date
      type: object
      required:
      - id
      - lang
      - author_id
      - author_name
      - author_image
      - created
      - stars
      - likes
      - comment
      title: PlayReview
    SummarySearchBody:
      properties:
        q:
          type: string
          title: Q
          description: Query
        filter:
          $ref: '#/components/schemas/SearchFilterPlay'
      type: object
      required:
      - filter
      title: SummarySearchBody
      example:
        filter:
          name: twitter
          published: true
    Suggest:
      properties:
        id:
          type: string
          title: Id
        term:
          type: string
          title: Term
        country:
          type: string
          title: Country
        added:
          type: string
          format: date-time
          title: Added
        lang:
          type: string
          title: Lang
        store:
          type: string
          title: Store
        crawled:
          type: string
          format: date-time
          title: Crawled
        app:
          type: string
          title: App
        results:
          items:
            type: string
          type: array
          title: Results
      type: object
      required:
      - id
      - term
      - country
      - added
      - lang
      - store
      title: Suggest
    CacheTime:
      type: string
      enum:
      - 1d
      - 7d
      - 30d
      title: CacheTime
      description: An enumeration.
    SearchFilterPlay:
      properties:
        id:
          items:
            type: string
          type: array
          title: Id
        name:
          type: string
          title: Name
        published:
          type: boolean
          title: Published
        category_type:
          $ref: '#/components/schemas/TypeEnum'
        revenue_month:
          $ref: '#/components/schemas/ValueRange'
        downloads_month:
          $ref: '#/components/schemas/ValueRange'
        release_date:
          $ref: '#/components/schemas/DateRange'
        update_date:
          $ref: '#/components/schemas/DateRange'
        rating_count:
          $ref: '#/components/schemas/ValueRange'
        developer:
          type: string
          title: Developer
        developer_id:
          type: string
          title: Developer Id
        editorial:
          type: boolean
          title: Editorial
        iap:
          type: boolean
          title: Iap
          description: In app purchases
        active_countries:
          items:
            type: string
          type: array
          title: Active Countries
        description_full:
          type: string
          title: Description Full
        description_short:
          type: string
          title: Description Short
        whatsnew:
          type: string
          title: Whatsnew
          description: Updates in app
        hosts:
          type: string
          title: Hosts
          description: Hosts
        with_ads:
          type: boolean
          title: With Ads
        advertised:
          type: boolean
          title: Advertised
        collection_id:
          type: string
          title: Collection Id
          description: Collection ID
        discovered:
          items:
            type: string
            format: date
          type: array
          title: Discovered
        website:
          type: string
          title: Website
          description: Website
        bundle:
          items:
            type: string
          type: array
          title: Bundle
          description: App bundle ID(s); accepts a single string or a list
        transferred:
          type: boolean
          title: Transferred
          description: Whether the app has been transferred to a new developer at least once
        transfer_date:
          allOf:
          - $ref: '#/components/schemas/DateRange'
          title: Transfer Date
          description: Date range (gte/lte) of the last developer transfer
        removal_date:
          allOf:
          - $ref: '#/components/schemas/DateRange'
          title: Removal Date
          description: Date range (gte/lte) of app removal from the store; matches removed (unavailable) apps
        category:
          allOf:
          - $ref: '#/components/schemas/PlayCategory'
          description: Category of app
        downloads_mark:
          type: integer
          title: Downloads Mark
          description: Installs
        downloads_daily:
          allOf:
          - $ref: '#/components/schemas/ValueRange'
          title: Downloads Daily
          description: Daily downloads or Daily installs
        downloads_exact:
          allOf:
          - $ref: '#/components/schemas/ValueRange'
          title: Downloads Exact
          description: Exact installs
        installs_exact:
          allOf:
          - $ref: '#/components/schemas/ValueRange'
          title: Installs Exact
          description: Exact installs(deprecated)
        review_count:
          allOf:
          - $ref: '#/components/schemas/ValueRange'
          title: Review Count
          description: Count of reviews
        chart_filter:
          allOf:
          - $ref: '#/components/schemas/ChartFilterPlay'
          title: Chart Filter
          description: Top Charts
        similar_apps:
          type: string
          title: Similar Apps
          description: Similars apps
        reverse_similar_apps:
          type: string
          title: Reverse Similar Apps
          description: Apps with app in similar`s lists
        rating_avg:
          allOf:
          - $ref: '#/components/schemas/ValueRange'
          title: Rating Avg
          description: Average rating
        developer_name:
          type: string
          title: Developer Name
          description: Developer name
        previous_developer_id:
          type: string
          title: Previous Developer Id
          description: Previous developer ID before transfer
        previous_developer_name:
          type: string
          title: Previous Developer Name
          description: Previous developer name before transfer
        pre_register:
          type: boolean
          title: Pre Register
          description: Pre-registration games only (True); matches apps in the pre-registration state in at least one tracked country
      type: object
      title: SearchFilterPlay
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: API-KEY