Application API
Use this API to get and create applications on ironSource’s dashboard.
Before you start make sure you go over our API introduction article.
Get Apps
Description
Use this API to retrieve a list of all of your applications. The response will include the following: app key, app name, app taxonomy, platform, bundle ID, creation date, app icon, status, ad units and mediated ad networks.
Authentication Type
Method
GET platform.ironsrc.com/partners/publisher/applications/v5?
Required Parameters
None
Request Example URL
https://platform.ironsrc.com/partners/publisher/applications/v5?
Response Parameters
Name | Description |
appKey | application Key (as seen on our platform) |
appName | the application name |
appStatus | app status can be active or inactive |
platform | iOS or Android |
bundleId | the store bundle id |
trackId | the app store track id (iOS only) |
taxonomy | the application sub-genre. for the list of all available sub-genres refer to this article |
creationDate | the date the app was added to ironSource platform |
icon | the app icon |
adUnits | includes the active ad networks names per ad unit |
network_reporting_api | includes the active ad network’s reporting API status |
JSON Example Response
[ { "appKey": "d32דדcfe9", "appName": "ironSourceApp1", "appStatus": "active", "platform": "iOS", "bundleId": "com.ironSourceApp1", "trackId": "1011768970", "taxonomy": "Other Casual", "creationDate": "2019-01-24", "icon": "https://is2-ssl.mzstatic.com/image/thumb/Purple118/v9/66/12/5b/66125bd9-d3e5-f900-af48-c464b7d4ee5a/source/512x512bb.jpg", "adUnits": { "rewardedVideo": { "activeNetworks": [ "ironSource", "UnityAds", "Vungle", "AdColony", "TapJoy", "AppLovin", "Facebook", "AdMob" ] }, "offerWall": { "activeNetworks": [ "ironSource" ] }, "interstitial": { "activeNetworks": [ "ironSource", "UnityAds", "Vungle", "AdColony", "TapJoy", "AppLovin", "Facebook", "AdMob" ] }, "banner": { "activeNetworks": [ "UnityAds", "Vungle", "AppLovin", "AdMob" ] } }, "networkReportingApi": { "ironSource": "verified", "UnityAds": "verified", "Vungle": "verified", "AdColony": "verified", "TapJoy": "verified", "AppLovin": "verified", "Facebook": "verified", "AdMob": "verified" }, "bundleRefId": 963347 }, { "appKey": "d320b325", "appName": "ironSourceApp2", "appStatus": "active", "platform": "iOS", "bundleId": "com.ironSourceApp1", "trackId": "1490125671", "taxonomy": "Puzzle", "creationDate": "N/A", "icon": "https://is2-ssl.mzstatic.com/image/thumb/Purple113/v9/23/e4/24/23e42437-6543-9281-8520-47ccdfee0290/source/512x512bb.jpg", "adUnits": { "rewardedVideo": { "activeNetworks": [ "ironSource", "UnityAds", "Vungle", "AdColony", "TapJoy", "AppLovin", "Facebook", "AdMob" ] }, "offerWall": { "activeNetworks": [ "ironSource" ] }, "interstitial": { "activeNetworks": [ "ironSource", "UnityAds", "Vungle", "AdColony", "TapJoy", "AppLovin", "Facebook", "AdMob" ] }, "banner": { "activeNetworks": [ "UnityAds", "Vungle", "AppLovin", "AdMob" ] } }, "networkReportingApi": { "ironSource": "verified", "UnityAds": "verified", "Vungle": "verified", "AdColony": "verified", "TapJoy": "verified", "AppLovin": "verified", "Facebook": "verified", "AdMob": "verified" }, "bundleRefId": 6890391 } ]
Create App
Description
Use this API to create an app on ironSource platform. When creating an app using the app creation API we automatically create each one of the supported ad units (Rewarded Video, Interstitial, Banner, Offerwall) on ‘Off’ status – unless requested otherwise.
Authentication Type
Method
POST platform.ironsrc.com/partners/publisher/applications/v5?
Required Parameters (for creation of a live application)
Name | Type | Description |
storeUrl | String | the store URL of the app |
taxonomy | String | the application sub-genre. for the list of all available sub-genres refer to this article |
Required Parameters (for creation of an application that is not live in the store)
Name | Type | Description |
appName | String | the application name |
platform | String | iOS or Android |
Optional Parameters
Name | Type | Description |
adUnit:status | String | “RewardedVideo”: “Live” |
Request Example URL
https://platform.ironsrc.com/partners/publisher/applications/v5?
Request Example Body (creation of a live application)
{ "storeUrl": "https://apps.apple.com/us/app/time-gap-hidden-objects/id661173158", "taxonomy": "puzzle", "adUnits": { "RewardedVideo": "Live", "Interstitial": "Live", "OfferWall": "Off", "Banner": "Live" } }
Request Example Body (creation of an application that is not live in the store)
{ "appName": "MyTestAppiOS", "platform": "iOS" }
JSON Response Example
{ "appKey": "5432456bd" }
API Versions
- API version v4 documentation