App List API
- API Name: Get Apps List
- Request Method: POST
- API URL:
/open-api/v1/data
- API Path:
/v3/api/open/app/list
- API Description: Get app 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/app/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 |
10 |
Yes |
|
| plat_type |
integer |
Platform type (0:all 1:tiktok 2:facebook) |
1 |
Yes |
|
| search_type |
integer |
Search type (1:Keyword 2:app name 3:app description 4:developer) |
1 |
Yes |
|
| sort |
integer |
Sort field (9:End Date, 8:Start Date, 1:Created Time, 2:Ratings, 3:Rate, 4:Num of ads, 5:Impressions, 6-Likes, 7-Ad Run Time, 10-Installs, 11-Monthly Installs, 12-Monthly Revenue(USD), 13-Influencers) |
1 |
Yes |
|
| sort_type |
string |
Sort type (asc:ascending desc:descending) |
"desc" |
Yes |
|
| time |
long |
Time range (0:all 1:yesterday 7:last 7 days 30:last 30 days 90:last 90 days) |
7 |
Yes |
|
| app_category |
string |
App category, multiple separated by commas |
"id6003,id6023" |
No |
|
| app_comment_count_max |
long |
Ratings, Maximum app comment count |
10000 |
No |
|
| app_comment_count_min |
long |
Ratings, Minimum app comment count |
1000 |
No |
|
| app_create_time_end |
long |
Created Time, App create time end (seconds) |
1643673600 |
No |
|
| app_create_time_start |
long |
Created Time, App create time start (seconds) |
1640995200 |
No |
|
| app_download_count_max |
long |
Installs, Maximum app download count |
10000000 |
No |
|
| app_download_count_min |
long |
Installs, Minimum app download count |
1000000 |
No |
|
| app_rating_max |
double |
Rate, Maximum app rate |
5.0 |
No |
|
| app_rating_min |
double |
Rate, Minimum app rate |
4.0 |
No |
|
| app_system |
string |
App system (ios/android) |
"ios" |
No |
|
| app_type |
string |
App type (app/game) |
"app" |
No |
|
| digg_count_max |
long |
Likes, Maximum like count |
100000 |
No |
|
| digg_count_min |
long |
Likes, Minimum like count |
10000 |
No |
|
| found_time_end |
long |
Start Date, First found time end (seconds) |
1643673600 |
No |
|
| found_time_start |
long |
Start Date, First found time start (seconds) |
1640995200 |
No |
|
| keyword |
string |
Search keyword |
"MercadoLibre" |
No |
|
| last_month_app_download_count_max |
long |
Monthly Installs, Maximum last month app download count |
100000 |
No |
|
| last_month_app_download_count_min |
long |
Monthly Installs, Minimum last month app download count |
10000 |
No |
|
| last_month_revenue_max |
double |
Monthly Revenue(USD), Maximum last month revenue (USD) |
10000.0 |
No |
|
| last_month_revenue_min |
double |
Monthly Revenue(USD), Minimum last month revenue (USD) |
1000.0 |
No |
|
| latest_found_time_end |
long |
End Date, Latest found time end (seconds) |
1643673600 |
No |
|
| latest_found_time_start |
long |
End Date, Latest found time start (seconds) |
1640995200 |
No |
|
| play_count_max |
long |
Impressions, Maximum play count |
10000000 |
No |
|
| play_count_min |
long |
Impressions, Minimum play count |
1000000 |
No |
|
| popular_person_count_max |
long |
Maximum popular person count |
100 |
No |
|
| popular_person_count_min |
long |
Minimum popular person count |
10 |
No |
|
| put_day_max |
long |
Ad Run Time, Maximum put day count |
30 |
No |
|
| put_day_min |
long |
Ad Run Time, Minimum put day count |
1 |
No |
|
| region |
string |
Country/Region, multiple separated by commas |
"BR,TW,MX" |
No |
|
| video_count_max |
long |
Maximum video count |
100 |
No |
|
| video_count_min |
long |
Minimum video count |
10 |
No |
|
Request Example
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/app/list",
"params": {
"current_page": 1,
"page_size": 10,
"plat_type": 1,
"search_type": 1,
"sort": 1,
"sort_type": "desc",
"time": 7,
"keyword": "MercadoLibre",
"app_type": "app",
"app_system": "ios",
"app_category": "id6003,id6023",
"region": "BR,TW,MX",
"app_rating_min": 4.0,
"app_rating_max": 5.0,
"app_download_count_min": 1000000,
"app_download_count_max": 10000000
}
}'
Response Parameters
Response Body Structure
{
"code": 200,
"message": "success",
"data": {
"data": [
// App 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 |
string/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 the request was successful |
| fail |
boolean |
Whether the request failed |
Data Object Fields (data)
| Field Name |
Type |
Description |
| data |
array[object] |
App list |
| page |
object |
Pagination information |
Data Item Fields
| Field Name |
Type |
Description |
| id |
string |
App external ID |
| platform |
array[string] |
Ad platform list (tiktok/facebook) |
| app_name |
string |
App name |
| created_time |
number |
App creation time (timestamp) |
| icon |
string |
App icon URL |
| app_system |
string |
App system type (ios/android) |
| app_type |
string |
App type (app/game) |
| app_store |
string |
App store (apple/google) |
| app_download_count |
number |
App download count |
| app_comment_count |
number |
App comment count |
| play_count |
number |
Ad play count |
| video_count |
number |
Ad video count |
| digg_count |
number |
Ad digg count |
| put_day |
number |
Ad put day |
| found_time |
number |
First found time (timestamp) |
| latest_found_time |
number |
Latest found time (timestamp) |
| is_collection |
boolean |
Is collected |
| last_month_app_download_count |
number |
Last month app download count |
| popular_person_count |
number |
Popular person count |
| region |
array[string] |
Region information list |
| app_category |
object |
App category information |
| app_rate |
object |
App rating information |
| last_month_revenue |
object |
Last month revenue information |
| latest_data |
array[object] |
Latest data list |
| app_dev_info |
object |
App developer information |
App Category Object Fields (app_category)
| Field Name |
Type |
Description |
| id |
string |
Category ID |
| name |
string |
Category name |
| type |
string |
Category type (app/game) |
| app_system |
string |
App system (ios/android) |
| children |
array[object] |
Sub-category list |
Sub-category Object Fields (children)
| Field Name |
Type |
Description |
| id |
string |
Sub-category ID |
| name |
string |
Sub-category name |
| type |
string |
Sub-category type (app/game) |
| app_system |
string |
App system (ios/android) |
App Rate Object Fields (app_rate)
| Field Name |
Type |
Description |
| score |
number |
Rating score |
| count |
number |
Rating count |
Last Month Revenue Object Fields (last_month_revenue)
| Field Name |
Type |
Description |
| unit |
string |
Unit (cent) |
| currency |
string |
Currency type (USD) |
| type |
string |
Type (currency) |
| value |
number |
Revenue value (in cents) |
Latest Data Object Fields (latest_data)
| Field Name |
Type |
Description |
| video_id |
string |
Video ID |
| platform |
number |
Platform type (1:tiktok 2:facebook) |
| url |
string |
Video cover URL |
| count |
number |
Play count |
App Developer Info Object Fields (app_dev_info)
| Field Name |
Type |
Description |
| id |
string |
Developer ID |
| name |
string |
Developer name |
Page Object Fields (page)
| Field Name |
Type |
Description |
| total_count |
number |
Total number of records |
| page_count |
number |
Total number of pages |
| current_page |
number |
Current page number |
| page_size |
number |
Page size |
| is_next |
boolean |
Whether there is next page |
Response Example
{
"code": 200,
"message": "success",
"data": {
"data": [
{
"platform": ["tiktok"],
"id": "87f57e4b74b194d57356",
"icon": "https://cdn-app.pipispy.com/28a87cbcf0d6e412064780e89b3f02da.jpg",
"region": ["BR", "TW"],
"app_name": "Mercado Libre: Compras Online",
"app_category": {
"children": [
{
"name": "Shopping",
"app_system": "ios",
"id": "id6024",
"type": "app"
},
{
"name": "Lifestyle",
"app_system": "ios",
"id": "id6012",
"type": "app"
}
],
"name": "App",
"app_system": "ios",
"id": "id36",
"type": "app"
},
"app_rate": {
"score": 4.8,
"count": 321513
},
"created_time": 1315540800,
"app_system": "ios",
"app_type": "app",
"app_store": "apple",
"app_download_count": 13000000,
"app_comment_count": 321513,
"play_count": 624429116,
"video_count": 15331,
"digg_count": 1897788,
"put_day": 1044,
"found_time": 1662073352,
"latest_found_time": 1752204713,
"is_collection": false,
"last_month_revenue": {
"unit": "cent",
"currency": "USD",
"type": "currency",
"value": 100000
},
"latest_data": [
{
"platform": 1,
"url": "https://cdn-video.pipispy.com/cover_645e142802a755d4cc01.jpg",
"count": 8606,
"video_id": "645e142802a755d4cc01"
}
],
"region": ["BR", "TW"],
"app_dev_info": {
"id": "463624855",
"name": "MercadoLibre"
},
"last_month_app_download_count": 1000000,
"popular_person_count": 0
}
],
"page": {
"total_count": 10000,
"page_count": 500,
"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 |