OpenRTB host request

The invitation to participate in an auction is sent using the POST method in JSON format (Content-Type: application/json).

{
  "source": {
    "fd": "(int)",
    "sourcetype": "(int)",
    "tid": "(string)",
    "ext": {
      "schain": {
        "complete": "(int)",
        "nodes": [
          {
            "asi": "(string)",
            "sid": "(string)",
            "hp": "(int)",
            "rid": "(string)"
          }
        ],
        "ver": "(string)"
      }
    }
  },
  "id": "(string)",
  "user": {
    "buyeruid": "(string)",
    "id" : "(string)",
    "ext": {
      "consent": "(string)"
    }
  },
  "imp": [
    {
      "bidfloor": "(float)",
      "bidfloorcur": "(string)",
      "displaymanager": "(string)",
      "id": "(string)",
      "instl": "(int)",
      "ext": {
        "unmoderated": "(int)"
      },
      "ext": {
        "skadn": {
          "version": "(string)",
          "versions": ["(array of strings)"],
          "sourceapp": "(int)",
          "skadnetids": [
            "(array of strings)"
          ]
        }
      }
      "secure": "(int)",
      "tagid": "(string)",
      "banner": {
        "api": [
          "(array of int)"
        ],
        "format": [
          {
            "h": "(int)",
            "w": "(int)"
          }
        ],
        "h": "(int)",
        "w": "(int)"
      },
      "displaymanagerver": "(string)",
      "clickbrowser": "(int)"
    }
  ],
  "tmax": "(int)",
  "app": {
    "bundle": "(string)",
    "publisher": {
      "id": "(string)"
    },
    "storeurl": "(string)",
    "id": "(string)",
    "content": {
      "language": "(string)"
    }
  },
  "bcat": [
    "(array of strings)"
  ],
  "cur": [
    "(array of strings)"
  ],
  "device": {
    "lmt": "(int)",
    "geo": {
      "country": "(string)"
    },
    "carrier": "(string)",
    "connectiontype": "(int)",
    "os": "(string)",
    "ip": "(string)",
    "ipv6": "(string)",
    "dnt": "(int)",
    "ifa": "(string)",
    "ua": "(string)",
    "devicetype": "(int)",
    "make": "(string)",
    "mccmnc": "(string)",
    "model": "(string)",
    "osv": "(string)",
    "h": "(int)",
    "w": "(int)",
    "language": "(string)",
    "dpidsha1": "(string)",
    "dpidmd5": "(string)",
    "ext": {
      "oaid": "(string)",
      "gaid": "(string)",
      "idfa": "(string)"
    }
  },
  "regs": {
    "coppa": "(int)",
    "ext": {
      "gdpr": "(int)",
      "nroa": {
        "version": "(string)",
        "mandatory": "(bool)"
      }
    }
  },
  "at": "(int)",
  "test": "(int)",
  "ext": {
    "notifications": {
      "lurl": "(int)",
      "nurl": "(int)"
    }
  }
}
Copied to clipboard

Request parameters
Bid Request object
Parameter	Description	Required
`source`	Information about the request source in the Source object.	yes
`id`	ID of the auction, assigned by the RTB host. The DSP returns this ID in the response.	yes
`user`	Information about the ad buyer in the User object.	yes
`cur`	List of currencies for bids. The following parameters are passed: RUB — Russian ruble USD — United States dollar. EUR — Euro. CHF — Swiss franc. TRY — Turkish lira. UAH — Ukrainian hryvnia. KZT — Kazakhstani tenge.	yes
`bcat`	Categories of blocked advertisers according to the IAB classification.	no
`imp`	Array of Imp objects that contain the parameters for rendering the banner. Each object corresponds to a single ad unit on the HTML page. In the current implementation, only one object is passed.	yes
`tmax`	The maximum response time in milliseconds during which bids need to be placed, taking into account the delay arising from the internet connection.	yes
`app`	Information about the app in the App object.	yes
`ext`	The Ext object with additional parameters.	no
`device`	Information about the endpoint in the Device object.	yes
`regs`	Industry, legal, or government regulations that apply to all impressions in the request, in the Regs object.	no
`at`	Auction type. Allowed values: 1 — First price auction. 2 — Second price auction.	no
`test`	Test mode indicator. Allowed values: 0 — Sending real traffic. 1 — Sending test traffic.	no
Ext object
`notifications`	The Ext.Notifications object with the URLs of notifications about winning or losing the bid.	no
Ext.Notifications object
`lurl`	The probability of calling a loss notification link. Possible statuses: 0 — No. 1 — Yes. 2 — Maybe.	no
`nurl`	The probability of calling a win notification link. Possible statuses: 0 — No. 1 — Yes. 2 — Maybe.	no
Imp object
`bidfloor`	The minimum cost per impression for the current auction, specified in CPM format.	yes
`bidfloorcur`	Currency letter code in ISO-4217 format. May differ from the offer currency returned by the bidder if permitted by the exchange.	yes
`displaymanager`	Monetizer or SDK name.	no
`id`	ID of the ad unit on the HTML page.	yes
`instl`	Ad type. Acceptable values: 0 — Non-interstitial ads. 1 — Interstitial ads.	yes
`ext`	The Imp.Ext object with additional parameters.	no
`secure`	Type of connection. Acceptable values: 0 — Unsecured connection (HTTP). 1 — Secured connection (HTTPS).	no
`tagid`	ID of the ad placement.	yes
`banner`	The Imp.Banner object with the default dimensions of the ad unit.	yes
`displaymanagerver`	Monetizer or SDK version.	yes
`clickbrowser`	Type of browser that opens when you tap the creative in the app. Allowed values: 0 — Built-in browser. 1 — Native browser.	yes
Imp.Banner object
`api`	List of supported API platforms.	no
`format`	The Imp.Banner.Format object with acceptable ad unit dimensions.	yes
`h`	Height of the block in pixels.	yes
`w`	Width of the block in pixels.	yes
Imp.Banner.Format object
`h`	Height of the block in pixels.	yes
`w`	Width of the block in pixels.	yes
Imp.Ext object
`unmoderated`	Auction moderation status. Allowed values: 0 — Unmoderated auction. 1 — Moderated auction.	yes
Imp.Ext.skadn object
`version`	The oldest version supported by the request.	no
`versions`	List of supported versions (depending on the SDK version and iOS version).	no
`sourceapp`	App identifier (matches with the app.bundle field).	no
`skadnetids`	List of identifiers obtained from the SDK.	no
App object
`bundle`	App ID in the App Store or Google Play.	no
`publisher`	Information about the placement in the App.Publisher object.	yes
`storeurl`	URL of the app store for the installed app.	no
`id`	The app ID.	yes
`content`	The App.Content object with information about the app contents.	no
App.Publisher object
`id`	The placement ID.	yes
App.Content object
`language`	The app language.	no
Device object
`lmt`	Ad tracking restriction set by the manufacturer of the endpoint device. 0 — Tracking is not limited. 1 — Tracking is limited.	yes
`geo`	The Device.Geo object with a description of the location of the endpoint device.	yes
`carrier`	Telecom operator or internet service provider.	no
`connectiontype`	Network connection type. 0 — Not defined. 1 — Ethernet (local area network). 2 — Wi-Fi. 3 — Cellular network. 4 – 2G cellular network. 5 – 3G cellular network. 6 – 4G cellular network.	no
`os`	Operating system.	yes
`ip`	The IP address of the endpoint device.	yes
`ipv6`	The IPv6 address of the endpoint device.	yes
`dnt`	Ad tracking restriction set by the endpoint device user. 0 — Tracking is not limited. 1 — Tracking is limited.	yes
`ua`	The value of the HTTP User-Agent header — The name of the application on the endpoint device.	yes
`ifa`	The advertising ID of the endpoint device.	yes
`devicetype`	The type of device. 1 — Phone. 3 — Smartphone. 4 — Tablet. 5 — Desktop.	no
`make`	The device manufacturer.	no
`mccmnc`	The unique mobile operator ID that is a combination of MCC and MNC codes separated by a hyphen.	no
`model`	The device model.	no
`osv`	The device's operating system version.	no
`h`	The height of the device.	no
`w`	The width of the device.	no
`language`	The language selected in the browser. The format used is ISO-639-1-alpha-2.	no
`dpidsha1`	The device platform identifier (for example, the Android identifier) hashed by the SHA1 algorithm.	no
`dpidmd5`	The device platform identifier (for example, the Android identifier) hashed by the MD5 algorithm.	no
`ext`	The Device.Ext object with additional parameters.	no
Device.Geo object
`country`	The ISO-3166-1 Alpha-3 country geocode.	yes
Device.Ext object
`oaid`	Device ID.	no
`gaid`	The ID for Android devices.	no
`idfa`	The ID for iOS devices.	no
User object
`id`	Exchange ID of the user.	no
`buyeruid`	Buyer ID.	no
`ext`	The User.Ext object with additional parameters.	no
User.Ext object
`consent`	Consent to transmit information about the buyer. Allowed values: 0 – Consent is not given. 1 – Consent is given.	no
Regs object
`coppa`	Flag indicating whether the request must comply with the Children's Online Privacy Protection Act (COPPA). 0 — No. 1 — Yes.	yes
`ext`	The Regs.Ext object with additional parameters.	no
Regs.Ext object
`gdpr`	Flag indicating whether the request must comply with the General Data Protection Regulation (GDPR). 0 — No. 1 — Yes.	yes
`nroa`	The parent object for the extension.	no
Ext.nroa object
`version`	Version number. For the current version, see the app.	no
`mandatory`	When the value is true, notifies that DSP responses without complete and correct information about the contracts will not be admitted to the auction.	no
Source object
`fd`	Final decision about serving the ad. 0 — Exchange. 1 — Original source.	yes
`sourcetype`	Request source. 1 — The request is received from a source other than Header bidding auction. 2 — The request comes from the auction's client side. 3 — The request comes from the server side.	yes
`tid`	Impression ID.	yes
`ext`	The Source.Ext object with additional parameters.	no
Source.Ext object
`schain`	The Source.Ext.Schain object with all participants in the inventory sales chain specified.	no
Source.Ext.Schain object
`complete`	The flag indicates whether the chain contains all nodes up to the original inventory source. Allowed values: 0 — No. 1 — Yes.	yes
`nodes`	Array of Source.Ext.Schain.Nodes objects with the order of participants in the chain.	yes
`ver`	`supply chain` specification version. Currently only version 1.0 exists.	yes
Source.Ext.Schain.Nodes object
`asi`	The canonical domain of the organization, must match the domain from ads.txt if such a domain exists.	yes
`sid`	The same `seller_id` for the publisher as in the sellers.json file.	yes
`hp`	Specifies whether this node should be included in the chain of inventory payment participants. If the value is 1, then the organization specified in the asi field pays the seller specified in the sid field. The seller is the organization that is responsible for paying the previous node in the chain. For version 1.0, the value should always be 1.	yes
`rid`	OpenRTB RequestId sent by the seller.	no
`name`	The official name of the organization, the field should not be present in the object if the organization is specified in sellers.json.	no
`domain`	The official domain of the organization, the field should not be present in the object if the organization is specified in sellers.json.	no

Request parameters
Bid Request object
Parameter	Description	Required
`source`	Information about the request source in the Source object.	yes
`id`	ID of the auction, assigned by the RTB host. The DSP returns this ID in the response.	yes
`user`	Information about the ad buyer in the User object.	yes
`cur`	List of currencies for bids. The following parameters are passed: RUB — Russian ruble USD — United States dollar. EUR — Euro. CHF — Swiss franc. TRY — Turkish lira. UAH — Ukrainian hryvnia. KZT — Kazakhstani tenge.	yes
`bcat`	Categories of blocked advertisers according to the IAB classification.	no
`imp`	Array of Imp objects that contain the parameters for rendering the banner. Each object corresponds to a single ad unit on the HTML page. In the current implementation, only one object is passed.	yes
`tmax`	The maximum response time in milliseconds during which bids need to be placed, taking into account the delay arising from the internet connection.	yes
`app`	Information about the app in the App object.	yes
`ext`	The Ext object with additional parameters.	no
`device`	Information about the endpoint in the Device object.	yes
`regs`	Industry, legal, or government regulations that apply to all impressions in the request, in the Regs object.	no
`at`	Auction type. Allowed values: 1 — First price auction. 2 — Second price auction.	no
`test`	Test mode indicator. Allowed values: 0 — Sending real traffic. 1 — Sending test traffic.	no
Ext object
`notifications`	The Ext.Notifications object with the URLs of notifications about winning or losing the bid.	no
Ext.Notifications object
`lurl`	The probability of calling a loss notification link. Possible statuses: 0 — No. 1 — Yes. 2 — Maybe.	no
`nurl`	The probability of calling a win notification link. Possible statuses: 0 — No. 1 — Yes. 2 — Maybe.	no
Imp object
`bidfloor`	The minimum cost per impression for the current auction, specified in CPM format.	yes
`bidfloorcur`	Currency letter code in ISO-4217 format. May differ from the offer currency returned by the bidder if permitted by the exchange.	yes
`displaymanager`	Monetizer or SDK name.	no
`id`	ID of the ad unit on the HTML page.	yes
`instl`	Ad type. Acceptable values: 0 — Non-interstitial ads. 1 — Interstitial ads.	yes
`ext`	The Imp.Ext object with additional parameters.	no
`secure`	Type of connection. Acceptable values: 0 — Unsecured connection (HTTP). 1 — Secured connection (HTTPS).	no
`tagid`	ID of the ad placement.	yes
`banner`	The Imp.Banner object with the default dimensions of the ad unit.	yes
`displaymanagerver`	Monetizer or SDK version.	yes
`clickbrowser`	Type of browser that opens when you tap the creative in the app. Allowed values: 0 — Built-in browser. 1 — Native browser.	yes
Imp.Banner object
`api`	List of supported API platforms.	no
`format`	The Imp.Banner.Format object with acceptable ad unit dimensions.	yes
`h`	Height of the block in pixels.	yes
`w`	Width of the block in pixels.	yes
Imp.Banner.Format object
`h`	Height of the block in pixels.	yes
`w`	Width of the block in pixels.	yes
Imp.Ext object
`unmoderated`	Auction moderation status. Allowed values: 0 — Unmoderated auction. 1 — Moderated auction.	yes
Imp.Ext.skadn object
`version`	The oldest version supported by the request.	no
`versions`	List of supported versions (depending on the SDK version and iOS version).	no
`sourceapp`	App identifier (matches with the app.bundle field).	no
`skadnetids`	List of identifiers obtained from the SDK.	no
App object
`bundle`	App ID in the App Store or Google Play.	no
`publisher`	Information about the placement in the App.Publisher object.	yes
`storeurl`	URL of the app store for the installed app.	no
`id`	The app ID.	yes
`content`	The App.Content object with information about the app contents.	no
App.Publisher object
`id`	The placement ID.	yes
App.Content object
`language`	The app language.	no
Device object
`lmt`	Ad tracking restriction set by the manufacturer of the endpoint device. 0 — Tracking is not limited. 1 — Tracking is limited.	yes
`geo`	The Device.Geo object with a description of the location of the endpoint device.	yes
`carrier`	Telecom operator or internet service provider.	no
`connectiontype`	Network connection type. 0 — Not defined. 1 — Ethernet (local area network). 2 — Wi-Fi. 3 — Cellular network. 4 – 2G cellular network. 5 – 3G cellular network. 6 – 4G cellular network.	no
`os`	Operating system.	yes
`ip`	The IP address of the endpoint device.	yes
`ipv6`	The IPv6 address of the endpoint device.	yes
`dnt`	Ad tracking restriction set by the endpoint device user. 0 — Tracking is not limited. 1 — Tracking is limited.	yes
`ua`	The value of the HTTP User-Agent header — The name of the application on the endpoint device.	yes
`ifa`	The advertising ID of the endpoint device.	yes
`devicetype`	The type of device. 1 — Phone. 3 — Smartphone. 4 — Tablet. 5 — Desktop.	no
`make`	The device manufacturer.	no
`mccmnc`	The unique mobile operator ID that is a combination of MCC and MNC codes separated by a hyphen.	no
`model`	The device model.	no
`osv`	The device's operating system version.	no
`h`	The height of the device.	no
`w`	The width of the device.	no
`language`	The language selected in the browser. The format used is ISO-639-1-alpha-2.	no
`dpidsha1`	The device platform identifier (for example, the Android identifier) hashed by the SHA1 algorithm.	no
`dpidmd5`	The device platform identifier (for example, the Android identifier) hashed by the MD5 algorithm.	no
`ext`	The Device.Ext object with additional parameters.	no
Device.Geo object
`country`	The ISO-3166-1 Alpha-3 country geocode.	yes
Device.Ext object
`oaid`	Device ID.	no
`gaid`	The ID for Android devices.	no
`idfa`	The ID for iOS devices.	no
User object
`id`	Exchange ID of the user.	no
`buyeruid`	Buyer ID.	no
`ext`	The User.Ext object with additional parameters.	no
User.Ext object
`consent`	Consent to transmit information about the buyer. Allowed values: 0 – Consent is not given. 1 – Consent is given.	no
Regs object
`coppa`	Flag indicating whether the request must comply with the Children's Online Privacy Protection Act (COPPA). 0 — No. 1 — Yes.	yes
`ext`	The Regs.Ext object with additional parameters.	no
Regs.Ext object
`gdpr`	Flag indicating whether the request must comply with the General Data Protection Regulation (GDPR). 0 — No. 1 — Yes.	yes
`nroa`	The parent object for the extension.	no
Ext.nroa object
`version`	Version number. For the current version, see the app.	no
`mandatory`	When the value is true, notifies that DSP responses without complete and correct information about the contracts will not be admitted to the auction.	no
Source object
`fd`	Final decision about serving the ad. 0 — Exchange. 1 — Original source.	yes
`sourcetype`	Request source. 1 — The request is received from a source other than Header bidding auction. 2 — The request comes from the auction's client side. 3 — The request comes from the server side.	yes
`tid`	Impression ID.	yes
`ext`	The Source.Ext object with additional parameters.	no
Source.Ext object
`schain`	The Source.Ext.Schain object with all participants in the inventory sales chain specified.	no
Source.Ext.Schain object
`complete`	The flag indicates whether the chain contains all nodes up to the original inventory source. Allowed values: 0 — No. 1 — Yes.	yes
`nodes`	Array of Source.Ext.Schain.Nodes objects with the order of participants in the chain.	yes
`ver`	`supply chain` specification version. Currently only version 1.0 exists.	yes
Source.Ext.Schain.Nodes object
`asi`	The canonical domain of the organization, must match the domain from ads.txt if such a domain exists.	yes
`sid`	The same `seller_id` for the publisher as in the sellers.json file.	yes
`hp`	Specifies whether this node should be included in the chain of inventory payment participants. If the value is 1, then the organization specified in the asi field pays the seller specified in the sid field. The seller is the organization that is responsible for paying the previous node in the chain. For version 1.0, the value should always be 1.	yes
`rid`	OpenRTB RequestId sent by the seller.	no
`name`	The official name of the organization, the field should not be present in the object if the organization is specified in sellers.json.	no
`domain`	The official domain of the organization, the field should not be present in the object if the organization is specified in sellers.json.	no

Sample request

{
  "source": {
    "fd": 0,
    "sourcetype": 3,
    "tid": "",
    "ext": {
      "schain": {
        "complete": 1,
        "nodes": [
          {
            "asi": "yandex.com",
            "sid": "12345",
            "hp": 1,
            "rid": "bidrequest123"
          }
        ],
        "ver": "1.0"
      }
    }
  },
  "id": "5834842956793170835",
  "user": {
    "buyeruid": "8fahfsfd9a",
    "id": "108799773262946888",
    "ext": {
      "consent": "1"
    }
  },
  "imp": [
    {
      "bidfloor": 0.01,
      "bidfloorcur": "USD",
      "displaymanager": "Yandex Mobile Ads SDK",
      "id": "10",
      "instl": 0,
      "ext": {
        "unmoderated": 0
      },
      "ext": {
        "skadn": {
          "version": "2.0",
          "versions": ["2.0", "2.1", "3.0"],
          "sourceapp": "880047117",
          "skadnetids": [
            "dticjx1a9i.skadnetwork",
            "8srfag4vvc.skadnetwork"
          ]
        }
      }
      "secure": 1,
      "tagid": "123123-10",
      "banner": {
        "format": [
          {
            "h": 300,
            "w": 300
          },
          {
            "h": 50,
            "w": 320
          },
          {
            "h": 250,
            "w": 300
          },
          {
            "h": 100,
            "w": 320
          }
        ],
        "h": 250,
        "w": 300
      },
      "displaymanagerver": "3.5.0",
      "clickbrowser": 1
    }
  ],
  "tmax": 200,
  "app": {
    "bundle": "ru.scanword.sloword",
    "publisher": {
      "id": "4626422"
    },
    "id": "123123",
    "content": {
      "language": "ru"
    }
  },
  "bcat": [
    ""
  ],
  "cur": [
    "RUB",
    "USD",
    "EUR",
    "TRY",
    "UAH",
    "KZT",
    "CHF"
  ],
  "device": {
    "lmt": 0,
    "ua": "com.yandex.mobile.metrica.ads.sdk/2.10 (Apple iPhone7,1; iOS 11.2.6) 229abba2",
    "ip": "",
    "ifa": "1DB9B91B-7520-4807-8D87-BE362369646E",
    "mccmnc": "",
    "dpidmd5": "",
    "geo": {
      "country": "RUS"
    },
    "dpidsha1": "",
    "carrier": "",
    "connectiontype": 0,
    "model": "iPhone7,1",
    "osv": "11.2.6",
    "make": "Apple",
    "os": "iOS",
    "devicetype": 1,
    "ipv6": "2a02:6b8:81:0:8cf6:c67:9042:972b",
    "w": 414,
    "h": 736,
    "dnt": 0,
    "language": "ru",
    "ext": {
      "gaid": "",
      "idfa": "1DB9B91B-7520-4807-8D87-BE362369646E",
      "oaid": ""
    }
  },
  "regs": {
    "coppa": 0,
    "ext": {
      "gdpr": 0,
      "nroa": {
        "version": "2",
        "mandatory": true
      }
    }
  },
  "at": 1,
  "ext": {
    "notifications": {
      "lurl": 1,
      "nurl": 1
    }
  }
}
Copied to clipboard