OpenAPI

Apps rankings

Query all-app, download and revenue, store-rank, or pre-order rankings.

POST/v1/apps/rankings

Authentication: X-API-Key
Required scope: apps:rankings:read
Billing: Pricing follows your active account rules
Rate limits: View your active rate limits

Parameters

Send this request as a JSON body.

ranking_typestringRequired

all · download · revenue · store_rank · pre_order

date_monthstringOptional

data_datestringOptional

pageintegerOptional

Default: 1

1 ≤ page ≤ ∞

sizeintegerOptional

Default: 10

1 ≤ size ≤ 100

allow_realtimebooleanOptional

Default: false

keywordstringOptional

platformstringOptional

scopestringOptional

chart_typestringOptional

country_idstringOptional

genre_idstringOptional

osstringOptional

areastringOptional

categorystringOptional

price_typestringOptional

free · paid

in_app_purchasestringOptional

Y · N

ratingstringOptional

4_5 · 4_0 · 3_0 · unrated

release_datestringOptional

last_release_datestringOptional

languagestringOptional

Response

successbooleanRequired

dataobjectOptional

rankings 接口响应。

Show fields

sourcestringRequired

ranking_typestringRequired

data_datestringRequired

updated_atstringOptional

totalintegerOptional

Default: 0

applied_filtersobjectOptional

recordsarrayOptional

Show fields

rankintegerOptional

rank_changeintegerOptional

app_idstringOptional

bundle_idstringOptional

diandian_idstringOptional

app_namestringOptional

logo_urlstringOptional

developerstringOptional

developer_urlstringOptional

platformstringOptional

devicestringOptional

country_idstringOptional

countrystringOptional

categorystringOptional

genresarrayOptional

Show fields

Schema details are unavailable for this endpoint.

ratingnumberOptional

rating_countintegerOptional

rating_count_listarrayOptional

Show fields

Schema details are unavailable for this endpoint.

store_ratingnumberOptional

store_rating_countintegerOptional

store_rating_sequencearrayOptional

Show fields

Schema details are unavailable for this endpoint.

store_screenshotsarrayOptional

Show fields

Schema details are unavailable for this endpoint.

store_languagesstringOptional

pricenumberOptional

price_unitstringOptional

price_labelstringOptional

release_datestringOptional

last_release_datestringOptional

versionstringOptional

descriptionstringOptional

store_urlstringOptional

is_adintegerOptional

is_tecdo_advintegerOptional

industriesarrayOptional

Show fields

Schema details are unavailable for this endpoint.

metric_keystringOptional

metric_valuenumberOptional

sourcestringRequired

report_datestringRequired

crawl_datestringOptional

update_timestringOptional

fallback_usedbooleanOptional

Default: false

fallback_reasonstringOptional

cache_statusstringOptional

hit · miss · stale · bypass

upstream_endpointstringOptional

errorobjectOptional

错误详情

Show fields

codeintegerRequired

业务错误码

messagestringRequired

可读错误信息

metaobjectOptional

响应元数据

Show fields

request_idstringOptional

请求唯一标识

Default: ""

pageintegerOptional

当前页码

sizeintegerOptional

每页数量

totalintegerOptional

总数

quota_remainingintegerOptional

剩余配额（-1 表示不限制）

Default: -1

service_levelstringOptional

本次请求的服务等级

langstringOptional

响应语言（cn/en），为空表示未翻译

platformstringOptional

本次请求的达人平台

recall_typestringOptional

召回类型：hybrid / vector / scalar

credits_consumedintegerOptional

本次请求扣减的积分数

Default: 0

credits_remainingintegerOptional

积分余额（-1 不限制）

Default: -1

billable_unitsintegerOptional

Server-calculated billable units for this response

Default: 0

0 ≤ billable_units ≤ ∞

skill_namestringOptional

调用方 skill 名称

skill_current_versionstringOptional

调用方 skill 当前版本

skill_latest_versionstringOptional

服务端声明的最新 skill 版本

skill_min_supported_versionstringOptional

服务端声明的最低支持版本

skill_update_availablebooleanOptional

是否存在可用 skill 更新

Default: false

skill_update_requiredbooleanOptional

是否要求更新 skill 后再继续使用

Default: false

skill_update_messagestringOptional

skill 更新提示文案

skill_update_manifest_urlstringOptional

skill 更新 manifest URL

Request example

curl -X POST 'http://api.creativault.vip/openapi/v1/apps/rankings' \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: $CV_API_KEY" \
  --data '{
  "ranking_type": "all",
  "page": 1,
  "size": 10
}'

This example is generated from the response schema.

Response example

{
  "success": true,
  "data": {
    "source": "example",
    "ranking_type": "example",
    "data_date": "example",
    "updated_at": "example",
    "total": 0,
    "applied_filters": {},
    "records": [
      {
        "rank": null,
        "rank_change": null,
        "app_id": null,
        "bundle_id": null,
        "diandian_id": null,
        "app_name": null,
        "logo_url": null,
        "developer": null,
        "developer_url": null,
        "platform": null,
        "device": null,
        "country_id": null,
        "country": null,
        "category": null,
        "genres": null,
        "rating": null,
        "rating_count": null,
        "rating_count_list": null,
        "store_rating": null,
        "store_rating_count": null,
        "store_rating_sequence": null,
        "store_screenshots": null,
        "store_languages": null,
        "price": null,
        "price_unit": null,
        "price_label": null,
        "release_date": null,
        "last_release_date": null,
        "version": null,
        "description": null,
        "store_url": null,
        "is_ad": null,
        "is_tecdo_adv": null,
        "industries": null,
        "metric_key": null,
        "metric_value": null,
        "source": "example",
        "report_date": "example",
        "crawl_date": null,
        "update_time": null
      }
    ],
    "fallback_used": false,
    "fallback_reason": "example",
    "cache_status": "hit",
    "upstream_endpoint": "example"
  },
  "error": null,
  "meta": {
    "request_id": "",
    "page": 1,
    "size": 1,
    "total": 1,
    "quota_remaining": -1,
    "service_level": "example",
    "lang": "example",
    "platform": "example",
    "recall_type": "example",
    "credits_consumed": 0,
    "credits_remaining": -1,
    "billable_units": 0,
    "skill_name": "example",
    "skill_current_version": "example",
    "skill_latest_version": "example",
    "skill_min_supported_version": "example",
    "skill_update_available": false,
    "skill_update_required": false,
    "skill_update_message": "example",
    "skill_update_manifest_url": "example"
  }
}

View error handling →