App Info

Endpoints for fetching and updating Pgyer app details, listing your uploads, and looking up an app by short URL.

Endpoints for app detail data: fetch details, update details, list your uploads, and look up an app by its short URL.

Get App Details

Returns the details for a specific version of an app; the response also includes a history summary.

POSThttps://www.pgyer.com/apiv2/app/view

Request Parameters

Parameter	Type	Required	Description
_api_key	String	Yes	API Key — see auth
appKey	String	Yes	See appKey
buildKey	String	No	See buildKey

Response

App detail fields:

Field	Type	Description
buildKey	String	Build Key, unique index ID for the app
buildType	Integer	App type (1: iOS; 2: Android)
buildIsFirst	Integer	Is this the first build (1: yes; 2: no)
buildIsLastest	Integer	Is this the latest version (1: yes; 2: no)
buildFileSize	Integer	Installer size
buildName	String	App name
iconUrl	String	App icon URL
buildVersion	String	Version number, default 1.0
buildVersionNo	String	Build version in the uploaded installer, default 1
buildBuildVersion	Integer	Pgyer-generated build number used to distinguish historical versions
buildIdentifier	String	App package identifier — BundleId on iOS, package name on Android
buildIcon	String	App icon key. Access URL is `https://cdn-app-icon2.pgyer.com/<buildIconPath>/<buildIcon>?x-oss-process=image/resize,m_lfit,h_120,w_120/format,jpg`; buildIconPath is the first 5 chars of buildIcon joined by `/`
buildDescription	String	App description
buildUpdateDescription	String	Release notes
buildScreenShots	String	Screenshot key; access URL is `https://www.pgyer.com/image/view/app_screenshots/<screenshot_key>`
buildScreenshotsUrl	Array	Screenshot URLs
buildShortcutUrl	String	App short URL
buildCates	String	App categories, comma-separated
buildQRCodeURL	String	App QR code URL
buildCreated	String	Upload time
buildUpdated	String	Update time
otherApps	Array	Historical versions; see the inner table below
otherAppsCount	Integer	Count of historical versions
todayDownloadCount	Integer	Today's total app downloads
todayBuildDownloadCount	Integer	Today's total version downloads

Historical-version fields (items inside otherApps):

Field	Type	Description
buildKey	String	Build Key, unique index ID for the app
buildName	String	App name
buildVersion	String	Version number, default 1.0
buildBuildVersion	Integer	Pgyer-generated build number
buildCreated	String	Upload time
buildUpdated	String	Update time

{
  "code": 0,
  "message": "",
  "data": {
    "buildKey": "a1b2c3d4e5f6",
    "buildType": 2,
    "buildIsFirst": 2,
    "buildIsLastest": 1,
    "buildFileSize": 12345678,
    "buildName": "Sample App",
    "iconUrl": "https://cdn-app-icon2.pgyer.com/1/2/3/a/b/123abcdefaaa",
    "buildVersion": "1.1",
    "buildVersionNo": "28",
    "buildBuildVersion": 5,
    "buildIdentifier": "com.example.app",
    "buildIcon": "123abcdefaaa",
    "buildDescription": "Sample description",
    "buildUpdateDescription": "Various bug fixes",
    "buildScreenShots": "",
    "buildScreenshotsUrl": [],
    "buildShortcutUrl": "abcd",
    "buildCates": "Tools,Productivity",
    "buildQRCodeURL": "https://www.pgyer.com/app/qrcode/abcd",
    "buildCreated": "2025-01-01 10:00:00",
    "buildUpdated": "2025-01-01 10:05:00",
    "otherApps": [
      {
        "buildKey": "a1b2c3d4e5f5",
        "buildName": "Sample App",
        "buildVersion": "1.0",
        "buildBuildVersion": 4,
        "buildCreated": "2024-12-01 10:00:00",
        "buildUpdated": "2024-12-01 10:05:00"
      }
    ],
    "otherAppsCount": 4,
    "todayDownloadCount": 12,
    "todayBuildDownloadCount": 8
  }
}

Update App Details (All Versions)

Update an app's details. The change applies to every version of the app.

POSThttps://www.pgyer.com/apiv2/app/update

Request Parameters

Parameter	Type	Required	Description
_api_key	String	Yes	API Key — see auth
appKey	String	Yes	See appKey
buildShortcutUrl	String	No	App short URL
buildInstallType	Integer	Yes	Install method (2: password; 3: invite)
buildPassword	String	No	Install password (used when `buildInstallType` is 2)
appIsInstallDate	Integer	No	Whether to set a validity window (1: yes; 2: no)
appInstallStartDate	String	No	Start of the window (used when `appIsInstallDate` is 1)
appInstallEndDate	String	No	End of the window (used when `appIsInstallDate` is 1)
appLang	Integer	No	Language (1: Chinese; 2: English; 3: auto)
buildVersionType	Integer	No	Build number (1: use Pgyer's auto-incrementing build number; 2: use the app's own build number)
appAutoSync	Integer	No	Auto-sync app info (1: yes; 2: no)
appShowPgyerCopyright	Integer	No	Show Pgyer copyright on the install page (1: yes; 2: no)
buildQrcodeShowAppIcon	Integer	No	Show the app icon in the QR code (1: yes; 2: no)
appFeedbackStatus	Integer	No	Enable feedback (1: yes; 2: no)
buildTemplate	String	No	Template: `classic`, `fashion`, `gray`, `green`, `colorful`

Response

Field	Type	Description
buildKey	String	Build Key, unique index ID for the app
buildType	Integer	App type (1: iOS; 2: Android)
buildIsFirst	Integer	Is this the first build (1: yes; 2: no)
buildIsLastest	Integer	Is this the latest version (1: yes; 2: no)
buildFileSize	Integer	Installer size
buildName	String	App name
buildPassword	String	Install password
buildVersion	String	Version number, default 1.0
buildVersionNo	String	Build version in the uploaded installer, default 1
buildQrcodeShowAppIcon	Integer	Show the app icon in the QR code (1: yes; 2: no)
buildVersionType	Integer	Use the Pgyer build number (1: yes; 2: no)
buildBuildVersion	Integer	Pgyer-generated build number
buildIdentifier	String	App package identifier — BundleId on iOS, package name on Android
buildIcon	String	App icon key. Access URL is `https://cdn-app-icon2.pgyer.com/<buildIconPath>/<buildIcon>?x-oss-process=image/resize,m_lfit,h_120,w_120/format,jpg`; buildIconPath is the first 5 chars of buildIcon joined by `/`
buildDescription	String	App description
buildUpdateDescription	String	Release notes
buildScreenShots	String	Screenshot key; access URL is `https://www.pgyer.com/image/view/app_screenshots/<screenshot_key>`
buildShortcutUrl	String	App short URL
buildIsAcceptFeedback	Integer	Feedback enabled (1: yes; 2: no)
buildTemplate	String	Template
buildInstallType	Integer	Install method (2: password; 3: invite)
buildManuallyBlocked	Integer	Manually blocked (1: yes; 2: no)
buildIsPlaceholder	Integer	Is a placeholder app (1: yes; 2: no)
buildCreated	String	Upload time
buildUpdated	String	Update time
buildQRCodeURL	String	App QR code URL
isOwner	Integer	Is your own app (1: yes; 2: no)
isJoin	Integer	Is an app you have joined (1: yes; 2: no)
appExpiredDate	String	App expiration date
appExpiredStatus	Integer	About to expire (1: yes; 2: no)
otherApps	Array	Other versions
otherAppsCount	Integer	Version count
todayDownloadCount	Integer	Today's downloads
appKey	String	App group key
appAutoSync	Integer	Sync to app market (1: yes; 2: no)
appShowPgyerCopyright	Integer	Show Pgyer copyright (1: yes; 2: no)
appDownloadPay	Integer	Amount or meaning corresponding to `appDownloadPay`
appDownloadDescription	String	Download description
appLang	Integer	App language (1: Chinese; 2: English; 3: auto)
appIsTestFlight	Integer	Is a TestFlight app (1: yes; 2: no)
appIsInstallDate	Integer	Has an install window (1: yes; 2: no)
appInstallStartDate	String	Install window start
appInstallEndDate	String	Install window end
appFeedbackStatus	Integer	Feedback enabled (1: yes; 2: no)
isMerged	Integer	Merged (1: yes; 2: no)
mergeAppInfo	Array	Info about the merged app

{
  "code": 0,
  "message": "",
  "data": {
    "appKey": "x1y2z3",
    "buildKey": "a1b2c3d4e5f6",
    "buildType": 2,
    "buildName": "Sample App",
    "buildVersion": "1.1",
    "buildVersionNo": "28",
    "buildBuildVersion": 5,
    "buildIdentifier": "com.example.app",
    "buildInstallType": 2,
    "buildPassword": "123456",
    "buildShortcutUrl": "abcd",
    "buildTemplate": "classic",
    "appIsInstallDate": 1,
    "appInstallStartDate": "2025-01-01",
    "appInstallEndDate": "2025-12-31",
    "appLang": 1,
    "appFeedbackStatus": 1,
    "buildQrcodeShowAppIcon": 1,
    "buildCreated": "2025-01-01 10:00:00",
    "buildUpdated": "2025-01-01 10:05:00"
  }
}

The example above shows the most common fields only — see the Fields tab for the full list.

Update App Details (Specific Version)

Update the details of a specific app version.

POSThttps://www.pgyer.com/apiv2/app/updateApp

Request Parameters

Parameter	Type	Required	Description
_api_key	String	Yes	API Key — see auth
userKey	String	Yes	User Key — identifies the current user. Find it on the API info page
buildKey	String	No	See buildKey
screenshot	File	No	App screenshot
buildShortcutUrl	String	No	App short URL
buildUpdateDescription	String	No	Release notes. Empty string clears the field
buildDescription	String	No	App description. Empty string clears the field
buildPassword	String	No	Install password. Empty string clears the field
buildVersion	String	No	Version number, default 1.0
buildInstallType	Integer	No	Install method

Response

Field	Type	Description
buildKey	String	Build Key, unique index ID for the app
buildType	Integer	App type (1: iOS; 2: Android)
buildIsFirst	Integer	Is this the first build (1: yes; 2: no)
buildIsLastest	Integer	Is this the latest version (1: yes; 2: no)
buildFileSize	Integer	Installer size
buildName	String	App name
buildVersion	String	Version number, default 1.0
buildVersionNo	String	Build version in the uploaded installer, default 1
buildBuildVersion	Integer	Pgyer-generated build number
buildIdentifier	String	App package identifier — BundleId on iOS, package name on Android
buildIcon	String	App icon key. Access URL is `https://cdn-app-icon2.pgyer.com/<buildIconPath>/<buildIcon>?x-oss-process=image/resize,m_lfit,h_120,w_120/format,jpg`; buildIconPath is the first 5 chars of buildIcon joined by `/`
buildDescription	String	App description
buildUpdateDescription	String	Release notes
buildScreenShots	String	Screenshot key; access URL is `https://www.pgyer.com/image/view/app_screenshots/<screenshot_key>`
buildShortcutUrl	String	App short URL
buildCreated	String	Upload time
buildUpdated	String	Update time

{
  "code": 0,
  "message": "",
  "data": {
    "buildKey": "a1b2c3d4e5f6",
    "buildType": 2,
    "buildIsFirst": 2,
    "buildIsLastest": 1,
    "buildFileSize": 12345678,
    "buildName": "Sample App",
    "buildVersion": "1.1",
    "buildVersionNo": "28",
    "buildBuildVersion": 5,
    "buildIdentifier": "com.example.app",
    "buildIcon": "123abcdefaaa",
    "buildDescription": "Sample description",
    "buildUpdateDescription": "Various bug fixes",
    "buildScreenShots": "",
    "buildShortcutUrl": "abcd",
    "buildCreated": "2025-01-01 10:00:00",
    "buildUpdated": "2025-01-01 10:05:00"
  }
}

Get App Info by Short URL

Look up basic info for an app by its short URL.

POSThttps://www.pgyer.com/apiv2/app/getByShortcut

Request Parameters

Parameter	Type	Required	Description
_api_key	String	Yes	API Key — see auth
buildShortcutUrl	String	Yes	App short URL. For `pgyer.com/PgY8`, pass just `PgY8`

Response

Field	Type	Description
buildKey	String	Build Key, unique index ID for the app
buildIsFirst	Integer	Is this the first build (1: yes; 2: no)
buildIsLastest	Integer	Is this the latest version (1: yes; 2: no)
buildType	Integer	App type (1: iOS; 2: Android)
buildFileName	String	Uploaded filename
buildFileSize	Integer	Installer size
buildName	String	App name
buildVersion	String	Version number, default 1.0
buildVersionNo	String	Build version in the uploaded installer, default 1
buildBuildVersion	Integer	Pgyer-generated build number
buildIdentifier	String	App package identifier — BundleId on iOS, package name on Android
buildCreated	String	Upload time
buildDescription	String	App description
buildUpdateDescription	String	Release notes
buildShortcutUrl	String	App short URL
buildScreenShots	String	Screenshot key; access URL is `https://www.pgyer.com/image/view/app_screenshots/<screenshot_key>`

{
  "code": 0,
  "message": "",
  "data": {
    "buildKey": "a1b2c3d4e5f6",
    "buildIsFirst": 2,
    "buildIsLastest": 1,
    "buildType": 2,
    "buildFileName": "app-release.apk",
    "buildFileSize": 12345678,
    "buildName": "Sample App",
    "buildVersion": "1.1",
    "buildVersionNo": "28",
    "buildBuildVersion": 5,
    "buildIdentifier": "com.example.app",
    "buildCreated": "2025-01-01 10:00:00",
    "buildDescription": "Sample description",
    "buildUpdateDescription": "Various bug fixes",
    "buildShortcutUrl": "PgY8",
    "buildScreenShots": ""
  }
}

List Your Uploaded Apps

Fetch a paginated list of apps uploaded under the current account.

POSThttps://www.pgyer.com/apiv2/app/listMy

Request Parameters

Parameter	Type	Required	Description
_api_key	String	Yes	API Key — see auth
page	Integer	No	Page number

Response

Field	Type	Description
buildKey	String	Build Key, unique index ID for the app
buildType	Integer	App type (1: iOS; 2: Android)
buildFileSize	Integer	Installer size
buildName	String	App name
buildVersion	String	Version number, default 1.0
buildVersionNo	String	Build version in the uploaded installer, default 1
buildBuildVersion	Integer	Pgyer-generated build number
buildIdentifier	String	App package identifier — BundleId on iOS, package name on Android
buildIcon	String	App icon key. Access URL is `https://cdn-app-icon2.pgyer.com/<buildIconPath>/<buildIcon>?x-oss-process=image/resize,m_lfit,h_120,w_120/format,jpg`; buildIconPath is the first 5 chars of buildIcon joined by `/`
buildCreated	String	Upload time
appKey	String	Unique key for the app group

{
  "code": 0,
  "message": "",
  "data": [
    {
      "buildKey": "a1b2c3d4e5f6",
      "buildType": 2,
      "buildFileSize": 12345678,
      "buildName": "Sample App",
      "buildVersion": "1.1",
      "buildVersionNo": "28",
      "buildBuildVersion": 5,
      "buildIdentifier": "com.example.app",
      "buildIcon": "123abcdefaaa",
      "buildCreated": "2025-01-01 10:00:00",
      "appKey": "x1y2z3"
    }
  ]
}

App Info

On this page