Documentation

Bid Request Examples

🚧

Note

BidMachine exchange currently works with openRTB 2.3 and 2.5. Provided examples are only valid for openRTB 2.3.

Banner Bid Request

{
"id":"d5260eec-75d9-4f7d-86bc-22b01b4c779e",
"imp":[{
    "id":"e58013b7-3e6e-4bcf-9121-1bcedeeb319c",
    "banner":{
        "w":320,
        "h":50,
        "battr":[5,8,9,10,14],
        "mimes":["image/jpg","image/gif","image/png"],
        "api":[5,3]},
    "displaymanager":"appodeal",
    "displaymanagerver":"1.15.8",
    "instl":0,
    "tagid":"1",
    "bidfloor":0.945,
    "bidfloorcur":"USD"}],
"app":{
    "id":"16848",
    "name":"Фантастика",
    "bundle":"ru.kuchaknig.android.freebooks.scifi",
    "storeurl":"https://play.google.com/store/apps/details?id=ru.kuchaknig.android.freebooks.scifi&hl=en",
    "cat":["IAB1-1"],
    "ver":"2.9.37",
    "paid":0,
    "publisher":{
        "id":"618",
        "name":"Роман"},
    "ext":{"bcat":[],
    "badv":[],
    "packagename":"ru.kuchaknig.android.freebooks.scifi"}
 
},
"device":{
    "ua":"Mozilla/5.0 (Linux; Android 4.0.4; Galaxy Nexus Build/IMM76B) AppleWebKit/535.19(KHTML, like Gecko) Chrome/18.0.1025.133 Mobile Safari/535.19",
    "geo":{
        "lat":56.8519,
        "lon":60.6122,
        "type":2,
        "country":"RUS",
        "zip":"620002",
        "utcoffset":300},
    "lmt":0,
    "ip":"213.87.249.67",
    "devicetype":4,
    "make":"DOOGEE",
    "model":"DOOGEE HT16",
    "os":"android",
    "osv":"6.0",
    "hwv":"DOOGEE HT16",
    "h":1280,
    "w":720,
    "js":1,
    "language":"ru",
    "carrier":"250-01",
    "connectiontype":3,
    "ifa":"6d670e54-ffe3-4318-9100-dd600ee040c4"},
"user":{
    "gender":"F",
    "geo":{
        "lat":56.8519,
        "lon":60.6122,
        "type":2,
        "country":"RUS",
        "zip":"620002",
        "utcoffset":300}},
"at":2,
"tmax":500,
"allimps":0,
"cur":["USD"],
"bcat":[],
"badv":[],
"source": {
      "fd": 1,
      "tid": "7578222740099842730",
      "ext": {
          "schain": {
              "complete": 1,
              "nodes": [
                  {
                      "asi": "seller.com",
                      "sid": "210676",
                      "hp": 1,
                      "rid": "7578222740099842730"
                  },
                  {
                      "asi": "bidmachine.io",
                      "sid": "124",
                      "hp": 1,
                      "rid": "ce4d7ece-aa68-4e9b-91f5-fc581ed0bde4"
                  }
              ],
              "ver": "1.0"
          }
      }
  }
}

Interstitial Bid Request

🚧

If Exchange is requesting a rewarded (non-skippable) interstitial, then we ALWAYS send "battr": [ 16 ] in Banner object. We also send 'imp.banner.ext.bannertype: "rewarded"' inside bid request.

If Exchange is requesting a skippable interstitial, then we DO NOT send "battr": [ 16 ] in Banner object.

{ 
   "id":"12f71145-a0f0-4b8b-a513-c051d0bb4159",
   "imp":[ 
      { 
         "id":"e9761ecc-f2fb-47b0-99d4-bc1a67cab07d",
         "banner":{ 
            "w":320,
            "h":480,
            "battr":[ 
               14,
               5,
               8,
               9,
               10
            ],
            "mimes":[ 
               "image/jpg",
               "image/gif",
               "image/png"
            ],
            "api":[ 
               5,
               3
            ]
         },
         "displaymanager":"appodeal",
         "displaymanagerver":"1.3.9",
         "instl":1,
         "tagid":"3",
         "bidfloor":13.568,
         "bidfloorcur":"USD"
      }
   ],
   "app":{ 
      "bundle":"1214661054",
      "storeurl":"https://itunes.apple.com/de/app/top-audio-excellent-player/id1214661054?mt=8&uo=4",
      "ver":"1.1",
      "id":"68629",
      "name":"Top Audio",
      "cat":[ 
         "IAB1-6",
         "IAB14"
      ],
      "publisher":{ 
         "id":"1582",
         "name":"Роман"
      },
      "ext":{ 
         "bcat":{ 
 
         },
         "badv":{ 
 
         },
         "packagename":"com.boom.topaudio"
      }
   },
   "device":{ 
      "ua":"Mozilla/5.0 (iPhone; CPU iPhone OS 10_1_1 like Mac OS X) AppleWebKit/602.2.14 (KHTML, like Gecko) Mobile/14B100",
      "ip":"212.41.49.81",
      "geo":{ 
         "lat":55.4792,
         "lon":37.3086,
         "ipservice":3,
         "country":"RUS",
         "city":"Troitsa",
         "zip":"142190",
         "type":2,
         "utcoffset":180,
         "ext":{ 
            "old_geo":{ 
               "lat":55.4792,
               "lon":37.3086,
               "country":"RUS",
               "zip":"142190",
               "type":2,
               "utcoffset":180
            }
         }
      },
      "carrier":"250-02",
      "language":"ru",
      "make":"Apple",
      "model":"iPhone6,2",
      "os":"ios",
      "osv":"10.1.1",
      "js":1,
      "connectiontype":2,
      "devicetype":4,
      "ifa":"10133A31-C4BF-489E-A310-B9241861E439",
      "h":568,
      "w":320,
      "hwv":"iPhone6,2"
   },
   "user":{ 
      "gender":"O",
      "geo":{ 
         "lat":55.4792,
         "lon":37.3086,
         "country":"RUS",
         "zip":"142190",
         "type":2,
         "utcoffset":180
      }
   },
   "at":2,
   "tmax":500,
   "cur":[ 
      "USD"
   ],
  "source": {
        "fd": 1,
        "tid": "7578222740099842730",
        "ext": {
            "schain": {
                "complete": 1,
                "nodes": [
                    {
                        "asi": "fyber.com",
                        "sid": "210676",
                        "hp": 1,
                        "rid": "7578222740099842730"
                    },
                    {
                        "asi": "bidmachine.io",
                        "sid": "124",
                        "hp": 1,
                        "rid": "ce4d7ece-aa68-4e9b-91f5-fc581ed0bde4"
                    }
                ],
                "ver": "1.0"
            }
        }
    }
}
For nonskippalbe (rewarded interstitials) we add "imp.banner.ext.bannertype: rewarded" to bid request. Example:

Rewarded interstitial bid request
{ 
   "id":"12f71145-a0f0-4b8b-a513-c051d0bb4159",
   "imp":[ 
      { 
         "id":"e9761ecc-f2fb-47b0-99d4-bc1a67cab07d",
         "banner":{ 
            "w":320,
            "h":480,
            "battr":[ 
               14,
               5,
               8,
               9,
               10
            ],
            "mimes":[ 
               "image/jpg",
               "image/gif",
               "image/png"
            ],
            "api":[ 
               5,
               3
            ],
            "ext":{
                "bannertype":"rewarded"
            }
         },
         "displaymanager":"appodeal",
         "displaymanagerver":"1.3.9",
         "instl":1,
         "tagid":"3",
         "bidfloor":13.568,
         "bidfloorcur":"USD"
      }
   ],
   "app":{ 
      "bundle":"1214661054",
      "storeurl":"https://itunes.apple.com/de/app/top-audio-excellent-player/id1214661054?mt=8&uo=4",
      "ver":"1.1",
      "id":"68629",
      "name":"Top Audio",
      "cat":[ 
         "IAB1-6",
         "IAB14"
      ],
      "publisher":{ 
         "id":"1582",
         "name":"Роман"
      },
      "ext":{ 
         "bcat":{ 
 
         },
         "badv":{ 
 
         },
         "packagename":"com.boom.topaudio"
      }
   },
   "device":{ 
      "ua":"Mozilla/5.0 (iPhone; CPU iPhone OS 10_1_1 like Mac OS X) AppleWebKit/602.2.14 (KHTML, like Gecko) Mobile/14B100",
      "ip":"212.41.49.81",
      "geo":{ 
         "lat":55.4792,
         "lon":37.3086,
         "ipservice":3,
         "country":"RUS",
         "city":"Troitsa",
         "zip":"142190",
         "type":2,
         "utcoffset":180,
         "ext":{ 
            "old_geo":{ 
               "lat":55.4792,
               "lon":37.3086,
               "country":"RUS",
               "zip":"142190",
               "type":2,
               "utcoffset":180
            }
         }
      },
      "carrier":"250-02",
      "language":"ru",
      "make":"Apple",
      "model":"iPhone6,2",
      "os":"ios",
      "osv":"10.1.1",
      "js":1,
      "connectiontype":2,
      "devicetype":4,
      "ifa":"10133A31-C4BF-489E-A310-B9241861E439",
      "h":568,
      "w":320,
      "hwv":"iPhone6,2"
   },
   "user":{ 
      "gender":"O",
      "geo":{ 
         "lat":55.4792,
         "lon":37.3086,
         "country":"RUS",
         "zip":"142190",
         "type":2,
         "utcoffset":180
      }
   },
   "at":2,
   "tmax":500,
   "cur":[ 
      "USD"
   ],
  "source": {
        "fd": 1,
        "tid": "7578222740099842730",
        "ext": {
            "schain": {
                "complete": 1,
                "nodes": [
                    {
                        "asi": "fyber.com",
                        "sid": "210676",
                        "hp": 1,
                        "rid": "7578222740099842730"
                    },
                    {
                        "asi": "bidmachine.io",
                        "sid": "124",
                        "hp": 1,
                        "rid": "ce4d7ece-aa68-4e9b-91f5-fc581ed0bde4"
                    }
                ],
                "ver": "1.0"
            }
        }
    }
}

Native Ad Bid Request

{
"id":"d97cef2b-36be-44fe-90ed-15f90666bbe7",
"imp":[{
    "id":"ae7c1c88-de6a-4893-8474-fe491024d159",
    "native":{
        "request":"{\"assets\":[{\"id\":123,\"required\":1,\"title\":{\"len\":40}},{\"id\":124,\"required\":1,\"img\":{\"type\":1,\"wmin\":50,\"hmin\":50,\"mimes\":                                            [\"image/jpg\",\"image/gif\",\"image/png\",\"image/jpeg\"]}},{\"id\":128,\"required\":1,\"img\":{\"type\":3,\"wmin\":1200,\"hmin\":627,\"mimes\":[\"image/jpg\",\"image/gif\",\"image/png\",\"image/jpeg\"]}},{\"id\":4,\"required\":0,\"video\":{\"mimes\":[\"video/mp4\"],\"minduration\":1,\"maxduration\":90,\"protocols\":[2,5]}},{\"id\":127,\"required\":1,\"data\":{\"type\":2}},{\"id\":7,\"required\":0,\"data\":{\"type\":3}},{\"id\":8,\"required\":0,\"data\":{\"type\":12}}],\"ver\":\"1.0\",\"plcmtcnt\":1,\"seq\":0}",
        "ver":"1.1",
        "api":[1,2,3,4,5]
    },
    "displaymanager":"appodeal",
    "displaymanagerver":"1.3.9",
    "instl":0,
    "tagid":"34",
    "bidfloor":0.0858,
    "bidfloorcur":"USD"
}],
"app":{
    "id":"41944",
    "name":"Color 6 (iOS)",
    "bundle":"1134511982",
    "storeurl":"https://itunes.apple.com/us/app/color-6/id1134511982?mt=8&uo=4",
    "cat":["IAB9-30","IAB9-30"],
    "ver":"1.0",
    "privacypolicy":0,
    "paid":0,
    "publisher":{
        "id":"2089",
        "name":"Aleksandr Filatov"},
        "ext":{
            "bcat":[],
            "badv":[],
            "packagename":"com.tigrido.color6"
        }
    },
"device":{
    "ua":"Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_1 like Mac OS X) AppleWebKit/603.1.30 (KHTML, like Gecko) Mobile/14E8301",
    "geo":{
        "lat":58.5966,
        "lon":49.6601,
        "type":2,
        "country":"RUS",
        "city":"Kirov",
        "zip":"249440",
        "utcoffset":180
    },
    "lmt":0,
    "ip":"77.72.140.9",
    "devicetype":4,
    "make":"Apple",
    "model":"x86_64",
    "os":"iOS",
    "osv":"10.3.1",
    "hwv":"x86_64",
    "h":568,
    "w":320,
    "js":1,
    "language":"en",
    "connectiontype":2,
    "ifa":"9611032A-935B-472A-878E-D4CBD9D4B192"
},
"user":{
    "gender":"O",
    "geo":{
        "lat":58.5966,
        "lon":49.6601,
        "type":2,
        "country":"RUS",
        "city":"Kirov",
        "zip":"249440",
        "utcoffset":180
    }
},
"at":2,
"tmax":250,
"allimps":0,
"cur":["USD"],
"bcat":[],
"badv":[],
"regs":{
    "coppa":0
    }
}

Video Bid Request

🚧

If Exchange is requesting a rewarded (non-skippable) video, then we ALWAYS send "battr": [ 16 ] in Video object. We also send 'imp.video.ext.videotype: "rewarded"' inside bid request.

If Exchange is requesting a skippable video, then we DO NOT send "battr": [ 16 ] in Video object. We also send 'imp.video.ext.videotype: "skippable"' inside the bid request.

Exchange does not support VPAID for now.

{
    "id":"ca0463e4-0c19-42c4-99e9-534713c6ee84",
    "imp":[{
        "id":"c1816ba0-d005-4d19-a11e-49147712e5b1",
        "video":{
            "mimes":["video/mp4"],
            "minduration":5,
            "maxduration":30,
            "protocols":[1,2,3,4,5,6],
            "w":480,
            "h":320,
            "linearity":1,
            "battr":[16],
            "playbackmethod":[1],
            "delivery":[1,2],
            "api":[],
            "ext":{"videotype":"rewarded"}
            },
        "displaymanager":"appodeal",
        "displaymanagerver":"2.1.10",
        "instl":1,
        "tagid":"82",
        "bidfloor":10.01,
        "bidfloorcur":"USD"
        }],
    "app":{
        "id":"7635",
        "name":"Appodeal Sandbox",
        "storeurl":"This app is not in store yet",
        "cat":["IAB24"],
        "ver":"4.0",
        "privacypolicy":0,
        "publisher":{
            "id":"1819",
            "name":"pub name"
            },
        "ext":{
            "finish":{},
            "imp":{},
            "app_uptime":1317,
            "click_count":0,
            "click":{},
            "session_uptime":15,
            "timp":{
                "interstitial":4
                },
            "sdk":"2.1.10",
            "tclick":{},
            "finish_count":4,
            "session_id":13,
            "tfinish":{
                "interstitial":4
                },
            "imp_count":4,
            "bcat":["IAB-30"],
            "badv":{},
            "packagename":"com.appodeal.sandbox"
            }
        },
    "device":{
        "ua":"Mozilla/5.0 (iPhone; CPU iPhone OS 11_2 like Mac OS X) AppleWebKit/604.4.7 (KHTML, like Gecko) Mobile/15C107",
        "geo":{
            "lat":58.5969,
            "lon":49.6583,
            "type":2,
            "country":"RUS",
            "city":"Kirov",
            "zip":"610000",
            "utcoffset":180
            },
        "lmt":0,
        "ip":"77.72.140.9",
        "devicetype":4,
        "make":"Apple",
        "model":"x86_64",
        "os":"iOS",
        "osv":"11.2",
        "hwv":"x86_64",
        "h":320,
        "w":568,
        "ppi":326,
        "pxratio":2,
        "js":1,
        "connectiontype":2,
        "ifa":"CCBD556A-14A7-4E26-A52C-652355D4BA5A",
        "ext":{
            "battery":-100,
            "rooted":"false"
            }
        },
    "user":{
        "gender":"O",
        "geo":{
            "lat":58.5969,
            "lon":49.6583,
            "type":2,
            "country":"RUS",
            "city":"Kirov",
            "zip":"610000",
            "utcoffset":180
            }
        },
    "at":2,
    "tmax":300,
    "allimps":0,
    "cur":["USD"],
    "bcat":["IAB-30"],
    "badv":[],
    "regs":{
        "coppa":0
        }
    }