Documentation

Documentation

  • General
  • Advertisers
  • Publishers
  • RTB
  • API
  • News

›Open RTB

Advertisers

  • Advertisers RTB Overview
  • Ad Exchange Partners
  • Integrating Advertising Demand
  • Open RTB

    • Open RTB Integration
    • Open RTB 2.4 Bid Request
    • Open RTB 2.4 Bid Response
    • Open RTB 2.5 Bid Request
    • Open RTB 2.5 Bid Response
    • Prebid / OpenRTB 2.5 Bid Request
    • Prebid / OpenRTB 2.5 Bid Response

    EXADS RTB

    • EXADS RTB Integration
    • EXADS RTB Bid Request
    • EXADS RTB Bid Response

Publishers

  • Publishers RTB Overview
  • Ad Exchange Partners
  • Integrating Publishing Supply
  • Open RTB

    • Open RTB Integration
    • Open RTB 2.4 Bid Request
    • Open RTB 2.4 Bid Response
    • Open RTB 2.5 Bid Request
    • Open RTB 2.5 Bid Response
    • Prebid / Open RTB 2.5 Bid Request
    • Prebid / Open RTB 2.5 Bid Response

    EXADS RTB

    • EXADS RTB Integration
    • EXADS RTB Bid Request
    • EXADS RTB Bid Response

IP Networks

  • IP Networks

Open RTB 2.5 Bid Request

Bid Request Headers

  • OpenRTB Version HTTP Header: x-openrtb-version: 2.5
  • Keep-Alive HTTP Header: Connection: Keep-Alive
  • Content JSON: Content-Type: application/json
  • Data Encoding Header: Accept-Encoding

 

Bid Request 2.5

When requesting bids for a specific context, the platform will perform an HTTP request with a timeout of 300ms and send the following object encoded as JSON in the request body. HTTP is recommended due to extra latency when using HTTPS.  

AttributeDescription
idUnique bid request ID (string)
siteDetails via a Site object about the publisher’s website (object)
deviceDetails via a Device object about the user’s device to which the impression will be delivered (object)
userDetails via a User object about the human user of the device; the advertising audience (object)
impDetails via an Imp object about the ad placement or impression being auctioned (object)
extPlaceholder for extensions to OpenRTB (object)

 

site

AttributeDescription
idUnique Site ID (string)
domainDomain name of the site (string)
catIAB category ID (string array)
pageFull URL of the page where the ad will be shown (string)
keywordsKeywords can be used to ensure ad zones get the right type of advertising. Keywords should be a string of comma-separated words
extPlaceholder for exchange-specific extensions (object)

 

site.ext

AttributeDescription
exchangecatCustom EXADS category ID (integer)
idzoneCustom EXADS Ad Zone ID (integer)
keywordMatching keyword if any (string)

 

device

AttributeDescription
uaBrowser user agent (string)
geoLocation of the device assumed to be the user’s current location defined by a Geo object
ipIP address of the user (string)*
ipv6IPv6 address of the user (string)*
languageBrowser language (string)
osOperating System (string)
jsSupport for JavaScript, where 0 = no, 1 = yes (integer)
extPlaceholder for exchange-specific extensions to OpenRTB (object)

 

device.geo

AttributeDescription
countryCountry ISO3
ipserviceService or provider used to determine geolocation from IP address if applicable (integer)

 

device.ext

AttributeDescription
remote_addrMain IP address of the user (string)
x_forwarded_forX-FORWARDED-FOR IP address of the user or empty if not set (string)

 

user

AttributeDescription
idUnique user ID (string)

 

user.ext

AttributeDescription
consentuser.ext.consent: This is the consent string required by the IAB standards. Negative consent only for now (string)

regs.ext

AttributeDescription
gdprregs.ext.gdpr: This is 0 if the caller believes that the user is not under GDPR, and 1 if the user is under GDPR. If neither, this parameter will be undefined.

 

imp

AttributeDescription
idA unique identifier for this impression within the context of the bid request (string)
instl1 = the ad is interstitial or full screen, 0 = not interstitial (integer)
videoDetails via Video object that represents an in-stream video impression
secureFlag to indicate if the impression requires secure HTTPS URL (integer)
extPlaceholder for exchange-specific extensions to OpenRTB (object)

 

imp.video

AttributeDescription
mimesContent MIME types supported (e.g., "video/mp4") (string array )
mindurationMinimum video ad duration in seconds (integer)
maxdurationMaximum video ad duration in seconds (integer)
protocolsArray of supported video protocols (integer)
linearityIndicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed (integer)
boxingallowedIndicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes (integer)
posAd position on screen (integer)
hWidth of the video player in device independent pixels (DIPS) (integer)
wHeight of the video player in device independent pixels (DIPS) (integer)
extPlaceholder for exchange-specific extensions to OpenRTB (object)

 

imp.video.ext

AttributeDescription
zone_typeZone type (e.g exchange_video_slider)

 

Examples

Video (Stored Request)

{
   "id": "b7da78ea-cce3-4524-a806-26ca48dd1857",
   "site": {
      "domain": "privesexopname.nl",
      "page": "https://sitedomain.com/page",
      "id": "718990",
      "keywords": "lifestyle,humour",
      "cat": [
         "IAB25-3"
      ],
      "ext": {
         "exchangecat": 508,
         "idzone": 4998567,
         "keyword": "%"
      },
      "publisher": {
         "id": "195600"
      }
   },
   "device": {
      "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36",
      "ip": "131.34.123.159",
      "geo": {
         "country": "IRL",
         "ipservice": "3"
      },
      "language": "en",
      "os": "MacOS",
      "js": 1,
      "ext": {
         "remote_addr": "131.34.123.159",
         "x_forwarded_for": ""
      }
   },
   "imp": [
      {
         "id": "568094473",
         "video": {
            "mimes": [
               "video/mp4"
            ],
            "minduration": "1",
            "maxduration": "7200",
            "ext": {
               "zone_type": "exchange_video_slider"
            },
            "protocols": "3,6",
            "linearity": "1",
            "boxingallowed": "1",
            "pos": "0"
         },
         "instl": "0",
         "ext": {
            "video_cta": "1",
            "type": "video"
         },
         "secure": "0"
      }
   ],
   "user": {
      "id": "57592f333f8983.043587162282415065"
   },
   "tmax": 300
}

You can find more examples here.

Video Bid Request Structure

  • site
    • site.ext
  • device
    • device.geo
    • device.ext
  • user
    • user-ext
  • regs.ext
  • imp
    • imp.video
    • imp.video.ext

 

← Open RTB 2.4 Bid ResponseOpen RTB 2.5 Bid Response →
  • Bid Request Headers
  • Bid Request 2.5
  • site
    • site.ext
  • device
    • device.geo
    • device.ext
  • user
    • user.ext
    • regs.ext
  • imp
    • imp.video
    • imp.video.ext
  • Examples
    • Video (Stored Request)
Documentation
Community
Github
Useful Links
EXADS
Copyright © 2025 EXADS