# 2003-Market-Search Volume Charts

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /ranking/volume-ranking:
    post:
      summary: 2003-Market-Search Volume Charts
      deprecated: false
      description: Query search volume data for keywords across countries/regions.
      operationId: 2003_Market_Search Volume Charts
      tags:
        - II. List of Interfaces/2. Market Services
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                regions:
                  type: array
                  description: Country/Region (query up to 8 countries per request)
                  examples:
                    - - US
                      - CN
                store:
                  type: string
                  description: App Store
                  examples:
                    - AS
                device:
                  type: string
                  description: AS store only
                  examples:
                    - IPHONE
                category:
                  type: string
                  description: Chart Type ID
                  examples:
                    - '36'
                keywords:
                  type: string
                  description: Keyword (optional)
                  examples:
                    - - |-
                        ["game1","game2"]
                        如果输入关键词则查询关键词
                type:
                  type: string
                  description: Keyword Type
                  examples:
                    - ALL
                limit:
                  type: string
                  description: Default 200, data volume limit
                  examples:
                    - TOP_200
              required:
                - keywords
              x-apifox-orders:
                - regions
                - store
                - device
                - category
                - keywords
                - type
                - limit
              x-apifox-ignore-properties: []
            example:
              regions:
                - US
                - CN
              store: AS
              device: IPHONE
              category: '36'
              type: ALL
              limit: TOP_200
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenApiBaseVOWankaVolumeRankingV2VO'
              example:
                requestParam:
                  regions:
                    - US
                    - CN
                    - KR
                    - JP
                  store: AS
                  device: IPHONE
                  category: '36'
                  keywords: null
                  type: ALL
                  limit: TOP_400
                result:
                  iconPrefix: https://is1-ssl.mzstatic.com/image/thumb
                  appInfoMap:
                    '282614216':
                      appName: eBay online shopping & selling
                      icon: >-
                        /Purple211/v4/36/c0/c4/36c0c492-bde2-897b-5f9e-b30f4553c274/AppIcon-0-0-1x_U007epad-0-1-0-85-220.png/88x88w.png
                    '282935706':
                      appName: Bible
                      icon: >-
                        /Purple221/v4/bf/5e/21/bf5e2186-6fff-3c00-49b1-0e238595522e/AppIcon-0-0-1x_U007epad-0-1-0-sRGB-0-85-220.png/88x88w.png
                  ranking:
                    - keyword: x
                      tag:
                        brandAppIds:
                          - '1250312807'
                          - '333903271'
                          - '1043429899'
                          - '587197095'
                        generic: true
                      regions:
                        - region: US
                          num: 95
                          trend:
                            - 96
                            - 96
                            - 95
                            - 95
                            - 95
                            - 95
                            - 95
                        - region: CN
                          num: 83
                          trend:
                            - 83
                            - 83
                            - 83
                            - 83
                            - 83
                            - 83
                            - 83
                        - region: KR
                          num: 97
                          trend:
                            - 97
                            - 97
                            - 97
                            - 97
                            - 97
                            - 97
                            - 97
                        - region: JP
                          num: 96
                          trend:
                            - 100
                            - 100
                            - 100
                            - 98
                            - 96
                            - 96
                            - 96
                  dateMap:
                    JP:
                      - '2025-12-02'
                      - '2025-12-03'
                    KR:
                      - '2025-12-02'
                      - '2025-12-03'
                    CN:
                      - '2025-12-02'
                      - '2025-12-03'
                    US:
                      - '2025-12-02'
                      - '2025-12-03'
                creditsCost:
                  requestCredits: 0
                  baseCredits: 400
                  extraCredits: 0
                  totalCostCredits: 400
                next: null
          headers: {}
          x-apifox-name: ''
      security:
        - apikey-header-x-openapi-key: []
      x-apifox-folder: II. List of Interfaces/2. Market Services
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4128055/apis/api-478038427-run
components:
  schemas:
    OpenApiBaseVOWankaVolumeRankingV2VO:
      type: object
      properties:
        requestParam:
          $ref: '#/components/schemas/WankaVolumeRankingQuery'
          description: Your request param.
        result:
          $ref: '#/components/schemas/WankaVolumeRankingV2VO'
          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-apifox-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-apifox-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-apifox-ignore-properties: []
      x-apifox-folder: ''
    WankaVolumeRankingV2VO:
      type: object
      properties:
        iconPrefix:
          type: string
          description: ''
        appInfoMap:
          $ref: '#/components/schemas/MapAppInfoVO'
          description: ''
        ranking:
          type: array
          items:
            $ref: '#/components/schemas/VolumeRankingVO'
            description: >-
              com.xiaoxi.openapi.model.vo.wanka.WankaVolumeRankingV2VO.VolumeRankingVO
          description: ''
        dateMap:
          $ref: '#/components/schemas/MapListLocalDate'
          description: ''
      x-apifox-orders:
        - iconPrefix
        - appInfoMap
        - ranking
        - dateMap
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    MapListLocalDate:
      type: object
      properties:
        key:
          type: array
          items:
            type: string
      x-apifox-orders:
        - key
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    VolumeRankingVO:
      type: object
      properties:
        keyword:
          type: string
          description: ''
        tag:
          $ref: '#/components/schemas/Tag'
          description: ''
        regions:
          type: array
          items:
            $ref: '#/components/schemas/RegionVolumeVO'
            description: >-
              com.xiaoxi.openapi.model.vo.wanka.WankaVolumeRankingV2VO.RegionVolumeVO
          description: ''
      x-apifox-orders:
        - keyword
        - tag
        - regions
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    RegionVolumeVO:
      type: object
      properties:
        region:
          type: string
          description: ''
        num:
          type: integer
          description: ''
        trend:
          type: array
          items:
            $ref: '#/components/schemas/VolumeTrend'
            description: com.xiaoxi.openapi.model.vo.wanka.WankaVolumeRankingVO.VolumeTrend
          description: ''
      x-apifox-orders:
        - region
        - num
        - trend
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    VolumeTrend:
      type: object
      properties:
        date:
          type: integer
          description: ''
          format: int64
        num:
          type: integer
          description: ''
      x-apifox-orders:
        - date
        - num
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    Tag:
      type: object
      properties:
        asa:
          type: boolean
          description: ''
        brand:
          type: boolean
          description: ''
        asaDetail:
          type: array
          items: &ref_0
            $ref: '#/components/schemas/AppInfoVO'
            description: ''
          description: ''
        brandApps:
          type: array
          items: *ref_0
          description: ''
        metaTypes:
          type: array
          items:
            type: string
            enum:
              - APP_NAME
              - SUB_TITLE
            x-apifox-enum:
              - value: APP_NAME
                name: APP_NAME
                description: App Name
              - value: SUB_TITLE
                name: SUB_TITLE
                description: Subtitle
          description: ''
      x-apifox-orders:
        - asa
        - brand
        - asaDetail
        - brandApps
        - metaTypes
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    AppInfoVO:
      type: object
      properties:
        appId:
          type: string
          description: ''
        icon:
          type: string
          description: ''
        title:
          type: string
          description: ''
      x-apifox-orders:
        - appId
        - icon
        - title
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    MapAppInfoVO:
      type: object
      properties:
        key:
          $ref: '#/components/schemas/key'
      x-apifox-orders:
        - key
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    key:
      type: object
      properties:
        appId:
          type: string
          description: ''
        appName:
          type: string
          description: ''
        icon:
          type: string
          description: ''
      x-apifox-orders:
        - appId
        - appName
        - icon
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    WankaVolumeRankingQuery:
      type: object
      properties:
        regions:
          type: array
          items:
            type: string
          description: ''
          minItems: 1
          maxItems: 8
          examples:
            - - US
              - CN
            - - US
              - CN
        store:
          type: string
          description: ''
          enum:
            - AS
            - GP
          x-apifox-enum:
            - value: AS
              name: AS
              description: AS
            - value: GP
              name: GP
              description: GP
          examples:
            - AS
        device:
          type: string
          description: ''
          enum:
            - IPHONE
            - IPAD
          x-apifox-enum:
            - value: IPHONE
              name: IPHONE
              description: IPHONE
            - value: IPAD
              name: IPAD
              description: IPAD
          examples:
            - IPHONE
        category:
          type: string
          description: ''
          examples:
            - '7014'
        keywords:
          type: array
          items:
            type: string
          description: ''
          examples:
            - |-
              ["game1","game2"]
              如果输入关键词则查询关键词
        type:
          type: string
          description: ''
          enum:
            - ALL
            - BRAND
            - GENERAL
          x-apifox-enum:
            - value: ALL
              name: ALL
              description: ALL
            - value: BRAND
              name: BRAND
              description: BRAND
            - value: GENERAL
              name: GENERAL
              description: GENERAL
          default: KeywordType.ALL
          examples:
            - ALL（默认）、BRAND、GENERAL
        limit:
          type: string
          description: ''
          enum:
            - TOP_200
            - TOP_400
            - TOP_5000
          x-apifox-enum:
            - value: TOP_200
              name: TOP_200
              description: TOP_200
            - value: TOP_400
              name: TOP_400
              description: TOP_400
            - value: TOP_5000
              name: TOP_5000
              description: TOP_5000
          default: '{size: 200, point: 200}'
          examples:
            - 200,400,5000
      x-apifox-orders:
        - regions
        - store
        - device
        - category
        - keywords
        - type
        - limit
      required:
        - store
        - category
        - type
        - limit
      x-apifox-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: []

```
