Bid Request

post

https://e.relay.bid/x/v1/openrtb2

Wrapper for the openrtb2 endpoint that initializes the task local log where we store request
and response information.
This version of the endpoint is meant for unauthenticated use, e.g. in a web browser.
Keeping public/authenticated URLs separate should let us better deal with invalid traffic
and maintaining QoS.
Note: we aren't yet doing authentication on the other endpoint.

The top-level bid request object contains a globally unique bid request or auction ID. This id attribute is required as is at least one impression object. Other attributes in this top-level object establish rules and restrictions that apply to all impressions being offered.

Body Params

OpenRTB 2.x Bid Request.

The top-level bid request object contains a globally unique bid request or auction ID. This id
attribute is required as is at least one impression object. Other attributes in this top-level
object establish rules and restrictions that apply to all impressions being offered.

allimps

int32 | null

≥ 0

Flag to indicate if Exchange can verify that the impressions
offered represent all of the impressions available in context
(e.g., all on the web page, all video spots such as pre/mid/post
roll) to support road-blocking. 0 = no or unknown, 1 = yes, the
impressions offered represent all that are available.

app

object | null

This object should be included if the ad supported content is a non-browser application (typically in
mobile) as opposed to a website. A bid request must not contain both an App and a Site object. At a
minimum, it is useful to provide an App ID or bundle, but this is not strictly required.

int64 | null

Auction type, where 1 = First Price, 2 = Second Price Plus. Exchange-specific auction types
can be defined using values greater than 500.

badv

array of strings | null

Block list of advertisers by their domains (e.g., “ford.com”).

badv

bapp

array of strings | null

Block list of applications by their platform-specific exchangeindependent application
identifiers. On Android, these should be bundle or package names (e.g., com.foo.mygame).
On iOS, these are numeric IDs.

bapp

bcat

array of strings | null

Blocked advertiser categories using the IAB content
categories.

bcat

bseat

array of strings | null

Block list of buyer seats (e.g., advertisers, agencies) restricted
from bidding on this impression. IDs of seats and knowledge
of the buyer’s customers to which they refer must be
coordinated between bidders and the exchange a priori. At
most, only one of wseat and bseat should be used in the
same request. Omission of both implies no seat restrictions.

bseat

cur

array of strings | null

Array of allowed currencies for bids on this bid request using
ISO-4217 alpha codes. Recommended only if the exchange
accepts multiple currencies.

cur

device

object | null

This object provides information pertaining to the device through which the user is interacting. Device
information includes its hardware, platform, location, and carrier data. The device can refer to a mobile
handset, a desktop computer, set top box, or other digital device.

ext

object | null

string

required

Unique ID of the bid request, provided by the exchange.

imp

array of objects

required

Array of Imp objects representing the impressions offered.

imp*

regs

object | null

site

object | null

This object should be included if the ad supported content is a website as opposed to a non-browser
application. A bid request must not contain both a Site and an App object. At a minimum, it is useful
to provide a site ID or page URL, but this is not strictly required.

source

object | null

test

int64 | null

Indicator of test mode in which auctions are not billable, where 0 = live mode,
1 = test mode.

tmax

int64 | null

≥ 0

Maximum time in milliseconds the exchange allows for bids to be received including Internet
latency to avoid timeout. This value supersedes any a priori guidance from the exchange.

user

object | null

This object contains information known or derived about the human user of the device (i.e., the
audience for advertising). The user id is an exchange artifact and may be subject to rotation or other
privacy policies. However, this user ID must be stable long enough to serve reasonably as the basis for
frequency capping and retargeting.

wlang

array of strings | null

White list of languages for creatives using ISO-639-1-alpha-2.
Omission implies no specific restrictions, but buyers would be
advised to consider language attribute in the Device and/or
Content objects if available.

wlang

wseat

array of strings | null

White list of buyer seats (e.g., advertisers, agencies) allowed
to bid on this impression. IDs of seats and knowledge of the
buyer’s customers to which they refer must be coordinated
between bidders and the exchange a priori. At most, only one
of wseat and bseat should be used in the same request.
Omission of both implies no seat restrictions.

wseat

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Bid received.