Documentation

Support

ironSource Ads

Monetization

User Acquisition

Get started as a DSP partner

ironSource Ads

Bidding API

Integrate the Bidding API to automate and optimize your bidding strategies for improved campaign performance.
Read time 2 minutesLast updated 4 hours ago
Bidding API allows you to manage campaign bids as well as bids for specific countries and applications. Each request gets or updates bids for a single campaign. A single campaign can support up to 350,000 bids.

Bid Logic

  • The default campaign bid will take place when no specific Country or Country-Application bid was set.
  • Each bid will be taken from the lowest level it was set on, alternatively, if there was no bid set on a specific level the bid will be taken from the level above in the hierarchy (campaign default > Country > Application).
  • Bids can be set with a maximum of 3 decimal points.
  • The minimum bid is $0.001.

Authentication

Bearer API authentication

Get Bids

Description: Get a list of bids for a single campaign. Method: GET Endpoint: https://api.ironsrc.com/advertisers/v4/multibid?

Parameters

Name

Mandatory

Data type

Description

campaignId
YesInteger
requestId
NoStringUsed for paginated requests.
resultsBulkSize
NoIntegerThe maximum number of records to return in the response is 20,000. The default is 10000.
pageNumber
NoIntegerUsed for paginated requests.

Request example

Get https://api.ironsrc.com/advertisers/v4/multibid?campaignId=123456

Response example

{
    "bids": [
  {
            "bid": 0.1
        },
        {
            "country": "US",
            "bid": 0.25
        },
        {
            "country": "US",
            "applicationId": 2222,
            "bid": 0.18
        },       
        {
            "country": "CA",
            "applicationId": 1212,
            "bid": 0.35
        }
    ]
   "totalResultsCount": 30043,
   "requestId": "MjU5NTY1Li41LjM1MDgwOA=="
}
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.

Insert and update bids

Description: Apply the default campaign bid and/or a list of bids per country and application for a single campaign.

Update bid logic

  • Define the Default bid by applying only the bid value
  • Define Country bid by applying both country and bid values
  • Define Country-Application bid by applying both country and application values
Method: PUT Endpoint: https://api.ironsrc.com/advertisers/v4/multibid?

Body parameters

Name

Mandatory

Data type

Description

campaignId
YesInteger
country
NoStringISO 3166 2-letter country code (for example, GB)
applicationId
Nointeger
bid
YesDecimalYou can insert or update up to 10000 bids per request

Request example

{
    "campaignId": 123456,
    "bids": [
  	  {
            "bid": 0.5
        },
        {
            "country": "AU",
            "bid": 0.8
        },
        {
            "country": "AU",
            "applicationId": 3333,
            "bid": 1.5
        },
        {
            "country": "AU",
            "applicationId": 1234,
            "bid": 2
        }
    ]
}
The campaign default bid is $0.50. For all application in AU the bid will be $0.80, except for appId 3333 that will be $1.50, and appId 1234 that it will be $2.

Delete Bids

Description: Delete a list of bids per country or per country-application. Deleting Country bid will set the country bid to be as the campaign default bid, and will not have an effect on Country-Application bids. You can delete up to 10,000 bids per request Method: DELETE Endpoint: https://api.ironsrc.com/advertisers/v4/multibid?

Body parameters

Name

Mandatory

Data type

Description

campaignId
YesInteger
country
YesStringISO 3166 2-letter country code (for example, GB)
applicationId
Nointeger

Request example

{
    "campaignId": 123456,
    "bids": [
        {
            "country": "AU"
        },
        {
            "country": "AU",
            "applicationId": 1234
        }
    ]
}