FoxData Open API
My License
My License
  1. LIST OF APIS
  • REFERENCE
    • Make Your First API Request
    • API Billing Rules
  • COMMON PARAMS
    • App Store Categories
    • Google Play Categories
    • Supported Countries/Languages
  • LIST OF APIS
    • App Metadata
      POST
    • App Metadata History
      POST
    • App Category Ranking
      POST
    • App Category Ranking History
      POST
    • App Metrics
      POST
    • App Metrics History
      POST
    • App Keyword
      POST
    • App Keyword History
      POST
    • Keywords Metrics
      POST
    • Keywords Metrics History
      POST
  1. LIST OF APIS

App Category Ranking History

POST
/expose/app/rank-history
Credits Cost
Cost TypeCost Credits
Request Credits1
Base Credits10
Extra Credits1 per day

Request

Header Params
x-openapi-key
string 
required
Default:
Your License
Body Params application/json
appId
string 
required
Application ID or packageName
region
string 
required
Two character region code,like US.
Default:
US
device
enum<string>  | enum<null> 
optional
App Store Device, only for AppStore query.
Allowed values:
IPHONEIPAD
timezone
integer  | null 
optional
Your timezone,enter 8 for UTC+8,enter -7 for UTC-7.
Default:
0
start
string  | null 
required
Start Date
end
string  | null 
required
End Date
Example
{
    "appId": "416048305",
    "region": "KR",
    "device": "IPHONE",
    "start": "2024-05-10",
    "end": "2024-05-14"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.foxdata.com/apiv1/expose/app/rank-history' \
--header 'x-openapi-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "416048305",
    "region": "KR",
    "device": "IPHONE",
    "start": "2024-05-10",
    "end": "2024-05-14"
}'

Responses

🟢200Success
application/json
Body
requestParam
object (AppRankHistoryQuery) 
optional
Your request param.
appId
string  | null 
required
Application ID or packageName
region
string  | null 
required
Two character region code,like US.
Default:
US
device
enum<string>  | enum<null> 
optional
App Store Device, only for AppStore query.
Allowed values:
IPHONEIPAD
timezone
integer  | null 
optional
Your timezone,enter 8 for UTC+8,enter -7 for UTC-7.
Default:
0
start
string  | null 
required
Start Date
end
string  | null 
required
End Date
result
object (AppRankHistoryVO) 
optional
Your response.
ranks
array[object (Rank) {3}]  | null 
optional
creditsCost
object (OpenApiPointCostVO) 
optional
Credits cost info.
requestCredits
integer  | null 
optional
baseCredits
integer  | null 
optional
extraCredits
integer  | null 
optional
totalCostCredits
integer  | null 
optional
Example
{"code":200,"msg":"success","data":{"requestParam":{"appId":"416048305","region":"KR","device":"IPHONE","timezone":0,"start":"2024-05-10","end":"2024-05-14"},"result":{"ranks":[{"categoryId":"6008","chartsType":"TOP_GROSSING","data":[{"date":"2024-05-10","value":8},{"date":"2024-05-11","value":7},{"date":"2024-05-12","value":7},{"date":"2024-05-13","value":7},{"date":"2024-05-14","value":7}]},{"categoryId":"36","chartsType":"FREE","data":[{"date":"2024-05-10","value":185},{"date":"2024-05-11","value":184},{"date":"2024-05-12","value":235},{"date":"2024-05-13","value":202},{"date":"2024-05-14","value":201}]},{"categoryId":"-1","chartsType":"FREE","data":[{"date":"2024-05-10","value":null},{"date":"2024-05-11","value":null},{"date":"2024-05-12","value":null},{"date":"2024-05-13","value":null},{"date":"2024-05-14","value":null}]},{"categoryId":"36","chartsType":"TOP_GROSSING","data":[{"date":"2024-05-10","value":45},{"date":"2024-05-11","value":38},{"date":"2024-05-12","value":39},{"date":"2024-05-13","value":41},{"date":"2024-05-14","value":46}]},{"categoryId":"-1","chartsType":"TOP_GROSSING","data":[{"date":"2024-05-10","value":140},{"date":"2024-05-11","value":103},{"date":"2024-05-12","value":103},{"date":"2024-05-13","value":115},{"date":"2024-05-14","value":135}]},{"categoryId":"6008","chartsType":"FREE","data":[{"date":"2024-05-10","value":11},{"date":"2024-05-11","value":11},{"date":"2024-05-12","value":11},{"date":"2024-05-13","value":8},{"date":"2024-05-14","value":9}]}]},"creditsCost":{"requestCredits":1,"baseCredits":10,"extraCredits":4,"totalCostCredits":15}}}
Previous
App Category Ranking
Next
App Metrics
Built with