# 4001-Keyword Search

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /app/search:
    post:
      summary: 4001-Keyword Search
      deprecated: false
      description: >-
        Query ranked apps by keyword (rank, covered keywords, traffic share,
        rating, latest release, first release, etc.).
      operationId: 4001_Keyword Search
      tags:
        - II. List of Interfaces/4. Kerword research Services
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appstore:
                  type: string
                  description: App Store
                  examples:
                    - GP
                region:
                  type: string
                  description: Country/Region
                  examples:
                    - CN
                device:
                  type: string
                  description: AS apps only
                  examples:
                    - IPAD
                keyword:
                  type: string
                  description: Keyword
                  examples:
                    - 武侠
                limit:
                  type: string
                  description: Default Query 200
                  examples:
                    - TOP_200
              x-apifox-orders:
                - appstore
                - region
                - device
                - keyword
                - limit
              x--orders:
                - appstore
                - region
                - device
                - keyword
                - limit
              x--ignore-properties: []
            example:
              appstore: GP
              region: CN
              device: IPAD
              keyword: 武侠
              limit: TOP_200
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApiBaseVOListWanKaSearchResultVO'
              examples:
                '1':
                  summary: Success Example
                  value:
                    requestParam:
                      appstore: GP
                      region: CN
                      keyword: 武侠
                      device: IPAD
                      limit: TOP_200
                    result:
                      - appId: com.chillyroom.worldofkungfu.gp
                        title: 大江湖之苍龙与白鸟
                        icon: >-
                          https://image3.foxdata.com/gp-proxy/4bedB6C4FXiNRKTybXUgrPmUh2C7CjsIsJvCF-bZIeyWKclbR-HZ58DZFpv_Xzb6Skw
                        subtitle: null
                        usage: 0
                        rank: 1
                        rankChange: 0
                        rankedKeywords: 7971
                        install: 0
                        ratingCount: 3736
                        updateDate: 1741864943000
                        releaseDate: 1741083603000
                    creditsCost:
                      requestCredits: 0
                      baseCredits: 150
                      extraCredits: 0
                      totalCostCredits: 150
                    next: null
                '2':
                  summary: Success Example
                  value:
                    requestParam:
                      appstore: GP
                      region: CN
                      keyword: 武侠
                      device: IPAD
                      limit: TOP_200
                    result:
                      - appId: com.chillyroom.worldofkungfu.gp
                        title: 大江湖之苍龙与白鸟
                        icon: >-
                          https://image3.foxdata.com/gp-proxy/4bedB6C4FXiNRKTybXUgrPmUh2C7CjsIsJvCF-bZIeyWKclbR-HZ58DZFpv_Xzb6Skw
                        subtitle: null
                        usage: 0
                        rank: 1
                        rankChange: 0
                        rankedKeywords: 7971
                        install: 0
                        ratingCount: 3736
                        updateDate: 1741864943000
                        releaseDate: 1741083603000
                    creditsCost:
                      requestCredits: 0
                      baseCredits: 150
                      extraCredits: 0
                      totalCostCredits: 150
                    next: null
          headers: {}
          x-apifox-name: ''
      security:
        - apikey-header-x-openapi-key: []
      x-apifox-folder: II. List of Interfaces/4. Kerword research Services
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4128055/apis/api-478038440-run
components:
  schemas:
    OpenApiBaseVOListWanKaSearchResultVO:
      type: object
      properties:
        requestParam:
          $ref: '#/components/schemas/WankaAppSearchQuery'
          description: Your request param.
        result:
          type: array
          items:
            $ref: '#/components/schemas/WanKaSearchResultVO'
            description: com.xiaoxi.openapi.model.vo.wanka.WanKaSearchResultVO
          description: Your response.
        creditsCost:
          $ref: '#/components/schemas/OpenApiPointCostVO'
          description: Credits cost info.
        next:
          $ref: '#/components/schemas/PaginationInfo'
          description: Next page info
      x-apifox-orders:
        - requestParam
        - result
        - creditsCost
        - next
      x--orders:
        - requestParam
        - result
        - creditsCost
        - next
      x--ignore-properties: []
      x-apifox-folder: ''
    PaginationInfo:
      type: object
      properties:
        taskId:
          type: string
          description: Task ID
        pageKey:
          type: string
          description: Page Key
        totalCount:
          type: integer
          description: Total Count
          format: int64
        totalPages:
          type: integer
          description: Total Pages
          format: int64
      x-apifox-orders:
        - taskId
        - pageKey
        - totalCount
        - totalPages
      x--orders:
        - taskId
        - pageKey
        - totalCount
        - totalPages
      x--ignore-properties: []
      x-apifox-folder: ''
    OpenApiPointCostVO:
      type: object
      properties:
        requestCredits:
          type: integer
          description: ''
        baseCredits:
          type: integer
          description: ''
        extraCredits:
          type: integer
          description: ''
        totalCostCredits:
          type: integer
          description: ''
      x-apifox-orders:
        - requestCredits
        - baseCredits
        - extraCredits
        - totalCostCredits
      x--orders:
        - requestCredits
        - baseCredits
        - extraCredits
        - totalCostCredits
      x--ignore-properties: []
      x-apifox-folder: ''
    WanKaSearchResultVO:
      type: object
      properties:
        appId:
          type: string
          description: ''
        title:
          type: string
          description: ''
        icon:
          type: string
          description: ''
        subtitle:
          type: string
          description: ''
        usage:
          type: integer
          description: ''
        rank:
          type: integer
          description: ''
        rankChange:
          type: integer
          description: ''
        rankedKeywords:
          type: integer
          description: ''
        install:
          type: integer
          description: ''
        ratingCount:
          type: integer
          description: ''
        updateDate:
          type: integer
          description: ''
          format: int64
        releaseDate:
          type: integer
          description: ''
          format: int64
      x-apifox-orders:
        - appId
        - title
        - icon
        - subtitle
        - usage
        - rank
        - rankChange
        - rankedKeywords
        - install
        - ratingCount
        - updateDate
        - releaseDate
      x--orders:
        - appId
        - title
        - icon
        - subtitle
        - usage
        - rank
        - rankChange
        - rankedKeywords
        - install
        - ratingCount
        - updateDate
        - releaseDate
      x--ignore-properties: []
      x-apifox-folder: ''
    WankaAppSearchQuery:
      type: object
      properties:
        appstore:
          type: string
          description: ''
          enum:
            - AS
            - GP
          x-apifox-enum:
            - value: AS
              name: AS
              description: AS
            - value: GP
              name: GP
              description: GP
          examples:
            - AS
        region:
          type: string
          description: ''
          examples:
            - US
        keyword:
          type: string
          description: ''
          examples:
            - games
        device:
          type: string
          description: ''
          enum:
            - IPHONE
            - IPAD
          x-apifox-enum:
            - value: IPHONE
              name: IPHONE
              description: IPHONE
            - value: IPAD
              name: IPAD
              description: IPAD
          default: '{value: 0}'
          examples:
            - IPHONE,IPAD
        limit:
          type: string
          description: ''
          enum:
            - TOP_200
            - ALL
          x-apifox-enum:
            - value: TOP_200
              name: TOP_200
              description: TOP_200
            - value: ALL
              name: ALL
              description: ALL
          default: '{size: 200, point: 150}'
          examples:
            - TOP_200
      x-apifox-orders:
        - appstore
        - region
        - keyword
        - device
        - limit
      required:
        - appstore
        - keyword
      x--orders:
        - appstore
        - region
        - keyword
        - device
        - limit
      x--ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    apikey-header-x-openapi-key:
      type: apiKey
      in: header
      name: x-openapi-key
servers:
  - url: https://api.foxdata.com/apiv1/open-api
    description: Api Server
security:
  - apikey-header-x-openapi-key: []

```