# App Developer Rank List API

## API Information

- **API Name**: Get Top Developers Rank List
- **Request Method**: POST
- **API URL**: `/open-api/v1/data`
- **API Path**: `/v3/api/open/rank/app-dev/list`
- **API Description**: Get app developer rank list information based on filter conditions, supports pagination
- **Pricing**: Retrieving one data result consumes 1 credit

**Request Headers:**

- Content-Type: application/json
- Accept: application/json

## Request Parameters

### Request Structure

| Parameter Name | Type   | Description                       | Example                          | Required | Default |
| -------------- | ------ | --------------------------------- | -------------------------------- | -------- | ------- |
| key            | string | User's external API request key   | "your_api_key_here"              | Yes      |         |
| uri            | string | Interface path                    | "/v3/api/open/rank/app-dev/list" | Yes      |         |
| params         | object | Interface input parameters object | See parameter list below         | Yes      |         |

### Parameter List (params object)

| Parameter Name                    | Type    | Description                                                                               | Example         | Required | Default |
| --------------------------------- | ------- |-------------------------------------------------------------------------------------------| --------------- | -------- | ------- |
| current_page                      | integer | Current page number                                                                       | 1               | Yes      |         |
| page_size                         | integer | Page size                                                                                 | 20              | Yes      |         |
| sort_key                          | string  | Sort field: digg_count_growth- Like , digg_growth_rate- Growth Rate , video_count- Number of ads ，app_download_count- Installs ，latest_download_count- Monthly Installs ，last_month_revenue- Monthly Revenue(USD)  | "count_growth"  | Yes      |         |
| sort_type                         | string  | Sort type: desc-descending, asc-ascending                                                 | "desc"          | Yes      |         |
| time                              | integer | Time range: 0-default, 1-1 day, 2-3 days, 3-7 days, 4-1 month, 5-3 months, 6-6 months     | 1               | Yes      |         |
| type                              | integer | Time type: 0-default, 1-Daily Ranking, 2-Weekly Ranking, 3-Monthly Ranking                                              | 1               | Yes      |         |
| app_category                      | string  | App category, multiple separated by commas                                                | "id6003,id6023" | No       |         |
| app_count_max                     | long    | Number of apps, Maximum app count                                                         | 50              | No       |         |
| app_count_min                     | long    | Number of apps, Minimum app count                                                         | 1               | No       |         |
| app_download_count_max            | long    | Maximum app download count                                                                | 1000000         | No       |         |
| app_download_count_min            | long    | Minimum app download count                                                                | 1000            | No       |         |
| app_system                        | string  | App system: ios/android                                                                   | "ios"           | No       |         |
| app_type                          | string  | App type: app/game                                                                        | "app"           | No       |         |
| count_growth_max                  | double  | Data growth maximum value (play count growth)                                             | 1000000         | No       |         |
| count_growth_min                  | double  | Data growth minimum value (play count growth)                                             | 1000            | No       |         |
| play_count_growth_max                  | long  | Impressions                                             | 1000000         | No       |         |
| play_count_growth_min                  | long  | Impressions                                             | 1000            | No       |         |
| digg_count_growth_max             | double  | Likes, Maximum Likes count growth                                                         | 10000           | No       |         |
| digg_count_growth_min             | double  | Likes, Minimum Likes count growth                                                         | 100             | No       |         |
| digg_growth_rate_max              | double  | Growth Rate, Maximum digg growth rate                                                     | 1.0             | No       |         |
| digg_growth_rate_min              | double  | Growth Rate, Minimum digg growth rate                                                     | 0.1             | No       |         |
| growth_rate_max                   | double  | Data growth rate maximum value                                                            | 1.0             | No       |         |
| growth_rate_min                   | double  | Data growth rate minimum value                                                            | 0.1             | No       |         |
| install_count_max                 | long    | Maximum install count                                                                     | 500000          | No       |         |
| install_count_min                 | long    | Minimum install count                                                                     | 1000            | No       |         |
| last_month_app_download_count_max | long    | Monthly Installs, Maximum last month app download count                                   | 50000           | No       |         |
| last_month_app_download_count_min | long    | Monthly Installs, Minimum last month app download count                                   | 1000            | No       |         |
| last_month_revenue_max            | double  | Monthly Revenue(USD),  Maximum last month revenue (USD)                                   | 100000          | No       |         |
| last_month_revenue_min            | double  | Monthly Revenue(USD), Minimum last month revenue (USD)                                    | 1000            | No       |         |
| plat_type                         | integer | Platform type: 0-all platforms, 1-TikTok, 2-Facebook                                      | 1               | No       |         |
| region                            | string  | Target regions, multiple separated by commas                                              | "US,CA,GB"      | No       |         |

### Request Example

```bash
curl -X POST "https://www.pipispy.com/open-api/v1/data" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "key": "your_api_key_here",
    "uri": "/v3/api/open/rank/app-dev/list",
    "params": {
      "current_page": 1,
      "page_size": 20,
      "sort_key": "count_growth",
      "sort_type": "desc",
      "time": 1,
      "type": 1,
      "app_category": "id6003,id6023",
      "app_count_min": 1,
      "app_count_max": 50,
      "app_download_count_min": 1000,
      "app_download_count_max": 1000000,
      "app_system": "ios",
      "app_type": "app",
      "count_growth_min": 1000,
      "count_growth_max": 1000000,
      "digg_count_growth_min": 100,
      "digg_count_growth_max": 10000,
      "digg_growth_rate_min": 0.1,
      "digg_growth_rate_max": 1.0,
      "growth_rate_min": 0.1,
      "growth_rate_max": 1.0,
      "install_count_min": 1000,
      "install_count_max": 500000,
      "last_month_app_download_count_min": 1000,
      "last_month_app_download_count_max": 50000,
      "last_month_revenue_min": 1000,
      "last_month_revenue_max": 100000,
      "popular_person_count_min": 1,
      "popular_person_count_max": 100,
      "plat_type": 1,
      "region": "US,CA,GB"
    }
  }'
```

## Response Parameters

### Response Body Structure

```json
{
  "code": 200,
  "message": "success",
  "data": {
    "data": [
      // App developer rank list items
    ],
    "page": {
      // Pagination information
    }
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 20,
  "success": true,
  "fail": false
}
```

### Response Field Description

##### Main Response Fields

| Field Name    | Type          | Description             |
| ------------- | ------------- | ----------------------- |
| **data**      | array[object] | App developer rank list |
| **page**      | object        | Pagination information  |
| **version**   | string        | API version             |
| **timestamp** | string/null   | Response timestamp      |
| **sign**      | string/null   | Response signature      |
| **remaining_credits** | number        | Current remaining available credits after this request |
| **consumed_credits**  | number        | Credits consumed by this request                       |
| **success**   | boolean       | Request success status  |
| **fail**      | boolean       | Request failure status  |

##### Data Item Fields

| Field Name             | Type          | Description                                 |
| ---------------------- | ------------- | ------------------------------------------- |
| id                     | string        | App developer unique identifier ID          |
| name                   | string        | App developer name                          |
| icon                   | string        | App developer icon URL                      |
| rate_score             | double        | Rating score                                |
| rate_count             | integer       | Rating count                                |
| play_count             | long          | Total play count                            |
| is_collection          | boolean       | Whether already collected                   |
| digg_count_growth_rate | double        | Digg count growth rate                      |
| max_cpm                | double        | Maximum CPM (Cost Per Mille)                |
| app_store              | array[string] | App store platforms (apple/google)          |
| revenue                | object        | Revenue information object                  |
| digg_count             | long          | Total digg count                            |
| latest_download_count  | long          | Latest download count                       |
| app_comment_count      | long          | App comment count                           |
| ad_platform_list       | array[string] | Advertising platform list (tiktok/facebook) |
| video_count            | long          | Video count                                 |
| app_system             | array[string] | App system platforms (ios/android)          |
| app_download_count     | long          | Total app download count                    |
| play_count_growth_rate | double        | Play count growth rate                      |
| min_cpm                | double        | Minimum CPM (Cost Per Mille)                |
| app_count              | long          | App count                                   |

##### Revenue Object Fields

| Field Name | Type   | Description            |
| ---------- | ------ | ---------------------- |
| unit       | string | Revenue unit (cent)    |
| currency   | string | Currency type (USD)    |
| type       | string | Value type (currency)  |
| value      | long   | Revenue value in cents |

##### Page Object Fields

| Field Name   | Type    | Description           |
| ------------ | ------- | --------------------- |
| total_count  | number  | Total count           |
| page_count   | number  | Total page count      |
| current_page | number  | Current page number   |
| page_size    | number  | Page size             |
| is_next      | boolean | Whether has next page |

### Response Example

```json
{
  "code": 200,
  "message": "success",
  "data": {
    "data": [
      {
        "id": "1322881000",
        "name": "TikTok Ltd.",
        "icon": "https://cdn-app.pipispy.com/fec3b999ed026c90c9ee9d2423fd634b.jpg",
        "rate_score": 0.0,
        "rate_count": 0,
        "play_count": 6435411646,
        "is_collection": false,
        "digg_count_growth_rate": 0.068,
        "max_cpm": 24544321.31,
        "app_store": ["apple"],
        "revenue": {
          "unit": "cent",
          "currency": "USD",
          "type": "currency",
          "value": 14400300000
        },
        "digg_count": 28094952,
        "latest_download_count": 6100000,
        "app_comment_count": 18931330,
        "ad_platform_list": ["tiktok", "facebook"],
        "video_count": 6284,
        "app_system": ["ios"],
        "app_download_count": 111100000,
        "play_count_growth_rate": 0.1867,
        "min_cpm": 6282994.0,
        "app_count": 5
      }
    ],
    "page": {
      "total_count": 6039,
      "page_count": 302,
      "current_page": 1,
      "page_size": 20,
      "is_next": true
    }
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 20,
  "success": true,
  "fail": false
}
```

## Error Code Description

| Error Code | Description                      |
| ---------- | -------------------------------- |
| 200        | Success                          |
| 400        | Bad Request - Invalid parameters |
| 401        | Unauthorized - Invalid API key   |
| 500        | Internal Server Error            |
