Titles API

Use the Title API to programmatically create, update, and manage your app titles on the ironSource platform.

Read time 4 minutes

"Title" is the entity of your application in the ironSource promote section. This API allows you to get the list of titles (bundles) linked to your account.

Authentication
Authentication

Bearer API authentication

Get Titles
Get Titles

Description: Use this API to retrieve a list of all of your titles (bundles). The response will include the following fields: id, bundleId, os, name.

Required Parameters: None

Method: GET

Endpoint: https://api.ironsrc.com/advertisers/v2/titles?

Parameters:

NameMandatoryData typeDescription
osNoStringFilter titles of a specified os. (Options: ios, android).
searchTermNoStringFilter by the name or partial name of the title.
requestIdNoNumberUsed for paginated requests.
resultsBulkSizeNoNumberUsed for paginated requests.
pageNumberNoNumberUsed for paginated requests.

Request Example

Get https://api.ironsrc.com/advertisers/v2/titles?

Response example

{
  "titles": [
    {
      "id": 113366,
      "bundleId": "com.yourcompany.MiniGame",
      "os": "android",
      "name": "Gaming mania"
    },
    {
      "id": 225566,
      "bundleId": "com.yourcompany.BestGame",
      "os": "ios",
      "name": "The Best Game"
    },
    {
      "id": 773366,
      "bundleId": "com.yourcompany.MusicGame",
      "os": "ios",
      "name": "Guitar Music"
    },
    {
      "id": 667722,
      "bundleId": "com.yourcompany.zombie2",
      "os": "android",
      "name": "Zombie Games"
    },
    {
      "id": 123456,
      "bundleId": "com.yourcompany.DancingWar",
      "os": "android",
      "name": "Dancing War"
    }
  ],
  "totalResultsCount": 5,
  "requestId": "MzUzMjIuODI5OTk5OS41LjI5"
}

For better performance - we strongly recommend to work with pagination requests in all cases,

To do so you should use 'resultsBulkSize' parameter - This parameter will limit the amount of the results you get in the response.

In order to get the next bulk of results, use ‘pageNumber’ parameter, combined with the ‘requestId’ parameter - which is received in the first response.

Pagination request Example URL:

In the first request you set the results number limitation: https://api.ironsrc.com/advertisers/v2/titles?resultsBulkSize=2

Pagination response example:

{
  "titles": [
    {
      "id": 113366,
      "bundleId": "com.yourcompany.MiniGame",
      "os": "android",
      "name": "Gaming mania"
    },
    {
      "id": 225566,
      "bundleId": "com.yourcompany.BestGame",
      "os": "ios",
      "name": "The Best Game"
    }
  ],
  "totalResultsCount": 5,
  "requestId": "MzUzMjIuODI5OTk5OS41LjI5"
}

For the next pages, use the requestId from the response and the required pageNumber.

For example: https://api.ironsrc.com/advertisers/v2/titles?requestId=MjE2MDkzLjUwMTEwMC4yLjE5&pageNumber=2

Keep increasing the ‘pageNumber’ param to get the following pages.

Create Titles
Create Titles

Description: Use this API to create title on ironSource platform.