# App New Rank List API

## API Information

- **API Name**: Get New Apps Rank List
- **Request Method**: POST
- **API URL**: `/open-api/v1/data`
- **API Path**: `/v3/api/open/rank/app-new/list`
- **API Description**: Get app new 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-new/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      |         |
| found_time       | double  | Discovery time range: 0-default, 1-3 days, 2-7 days, 3-1 month, 4-3 months, 5-6 months, 6-all                   | 1               | Yes      |         |
| page_size        | integer | Page size                                                                                                       | 20              | Yes      |         |
| sort_key         | string  | Sort field: count_growth-play count growth, growth_rate-growth rate, video_count-ad count                       | "count_growth"  | Yes      |         |
| sort_type        | string  | Sort type: desc-descending, asc-ascending                                                                       | "desc"          | Yes      |         |
| type             | integer | Time type: 0-default, 1-24 hours, 2-3 days, 3-7 days                                                            | 1               | Yes      |         |
| create_time_type | integer | Creation time types: 1 to 6 recent 3 days, recent 7 days, recent 1 month, recent 3 months, recent 6 months, all | 1               | Yes      |         |
| app_category     | string  | App category, multiple separated by commas                                                                      | "id6003,id6023" | 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       |         |
| growth_rate_max  | double  | Data growth rate maximum value                                                                                  | 1.0             | No       |         |
| growth_rate_min  | double  | Data growth rate minimum value                                                                                  | 0.1             | 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-new/list",
    "params": {
      "current_page": 1,
      "found_time": 1,
      "page_size": 20,
      "sort_key": "count_growth",
      "sort_type": "desc",
      "type": 1,
      "app_category": "id6003,id6023",
      "app_system": "ios",
      "app_type": "app",
      "count_growth_min": 1000,
      "count_growth_max": 1000000,
      "growth_rate_min": 0.1,
      "growth_rate_max": 1.0,
      "plat_type": 1,
      "region": "US,CA,GB"
    }
  }'
```

## Response Parameters

### Response Body Structure

```json
{
  "code": 200,
  "message": "success",
  "data": {
    "data": [
      // App 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          |
| ------------- | ------------ | -------------------- |
| **code**      | integer      | Response status code |
| **message**   | string       | Response message     |
| **data**      | object       | Response data object |
| **version**   | string       | API version number   |
| **timestamp** | integer/null | Timestamp            |
| **sign**      | string/null  | Signature            |
| **remaining_credits** | number        | Current remaining available credits after this request |
| **consumed_credits**  | number        | Credits consumed by this request                       |
| **success**   | boolean      | Whether successful   |
| **fail**      | boolean      | Whether failed       |

##### Data Object Fields

| Field Name | Type          | Description            |
| ---------- | ------------- | ---------------------- |
| **data**   | array[object] | App rank list          |
| **page**   | object        | Pagination information |

##### Data Item Fields

| Field Name             | Type          | Description                                  |
| ---------------------- | ------------- | -------------------------------------------- |
| id                     | string        | App unique identifier ID                     |
| app_name               | string        | App name                                     |
| icon                   | string        | App icon URL                                 |
| platform               | array[string] | Platform list, e.g. ["tiktok", "facebook"]   |
| region                 | array[string] | Target regions list, e.g. ["US", "CA", "GB"] |
| app_category           | object        | App category information                     |
| app_rate               | object        | App rating information                       |
| app_type               | string        | App type (app/game)                          |
| app_store              | string        | App store (apple/google)                     |
| app_download_count     | long          | Download count                               |
| app_comment_count      | long          | Comment count                                |
| play_count             | long          | Play count                                   |
| video_count            | long          | Video count                                  |
| digg_count             | long          | Like count                                   |
| put_day                | integer       | Days since launch                            |
| found_time             | long          | Discovery timestamp                          |
| latest_found_time      | long          | Latest discovery timestamp                   |
| is_collection          | boolean       | Whether already collected                    |
| last_month_revenue     | object        | Last month revenue information               |
| play_count_growth_rate | double        | Play count growth rate                       |
| digg_growth_rate       | double        | Like growth rate                             |
| latest_download_count  | long          | Latest download count                        |
| app_dev_info           | object        | Developer information                        |
| created_time           | long          | Creation timestamp                           |

##### App Category Object Fields

| Field Name | Type          | Description       |
| ---------- | ------------- | ----------------- |
| id         | string        | Category ID       |
| name       | string        | Category name     |
| type       | string        | Category type     |
| app_system | string        | App system        |
| children   | array[object] | Sub-category list |

##### App Rating Object Fields

| Field Name | Type   | Description  |
| ---------- | ------ | ------------ |
| score      | double | Rating score |
| count      | long   | Rating count |

##### Revenue Object Fields

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

##### Developer Info Object Fields

| Field Name  | Type   | Description             |
| ----------- | ------ | ----------------------- |
| name        | string | Developer name          |
| icon        | string | Developer icon          |
| id          | string | Developer ID            |
| email       | string | Developer email         |
| url         | string | Developer link          |
| website_url | string | Website link (optional) |
| avatar      | string | Avatar (optional)       |

##### 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": [
      {
        "platform": ["tiktok"],
        "id": "44eced5a4740e4062566",
        "icon": "https://cdn-app.pipispy.com/f1e8e137f2582e41f5e7bccd327e954d.jpg",
        "region": ["ID", "JP", "SG", "US", "TH", "MY", "CA"],
        "app_name": "Lemon8 - Lifestyle Community",
        "app_category": {
          "id": "googleapp",
          "name": "App",
          "type": "app",
          "app_system": "android",
          "children": [
            {
              "id": "LIFESTYLE",
              "name": "Lifestyle",
              "type": "app",
              "app_system": "android"
            }
          ]
        },
        "app_rate": {
          "score": 4.7058825,
          "count": 201979
        },
        "app_type": "app",
        "app_store": "google",
        "app_download_count": 28744075,
        "app_comment_count": 202439,
        "play_count": 352576845,
        "video_count": 396,
        "digg_count": 13886211,
        "put_day": 717,
        "found_time": 1690011301,
        "latest_found_time": 1752131772,
        "is_collection": false,
        "last_month_revenue": {
          "unit": "cent",
          "currency": "USD",
          "type": "currency",
          "value": 100000
        },
        "play_count_growth_rate": 0.1841,
        "digg_growth_rate": 0.3007,
        "latest_download_count": 1000000,
        "app_dev_info": {
          "name": "TikTok Pte. Ltd.",
          "icon": "f1e8e137f2582e41f5e7bccd327e954d.jpg",
          "id": "8354621850408287155",
          "email": "contact@lemon8-app.com",
          "url": "https://play.google.com/store/apps/developer?id=TikTok+Pte.+Ltd."
        },
        "created_time": 1583425601
      }
    ],
    "page": {
      "total_count": 6645,
      "page_count": 333,
      "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            |
