Bid request

post

http://localhost:8080/api/bid/{retailer_id}

An RTB bid request is a message from an ad exchange to advertisers, sharing details about an ad impression to request bids for programmatic ad placement
Use this to make an RTB bid request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

retailer_id

int32

required

≥ 1

Streaem Retailer Id

Body Params

Other subordinates to the BidRequest provide various forms of information to assist bidders in making
targeting and pricing decisions. This includes details about the user, the device they’re using, the
location of either, regulatory constraints, and the content and media in which the impression will occur.

On the latter, there is the distinction between site (i.e., website) and application (i.e., non-browser app
typically in mobile). The abstract class called DistributionChannel is just a modeling concept to
indicate that a BidRequest is related to either a Site or an App, but not both (i.e., a distribution
channel is an abstraction of site and app). Both sites and apps can be further described by data about
their publisher, the content, and the content’s producer.

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. At least 1 Imp object is required.

imp*

site

object

Details via a Site object about the publisher’s website. Only applicable and recommended for websites

app

object

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.

device

object

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.

user

object

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.

test

integer

0 to 1

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

integer

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

tmax

integer

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.

wseat

array of strings

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

bseat

array of strings

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

allImps

integer

0 to 1

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.

cur

array of objects

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

cur

wlang

array of objects

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

bcat

array of strings

Blocked advertiser categories using the IAB content
categories. See https://iabtechlab.com/standards/content-taxonomy/

bcat

badv

array of strings

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

badv

bapp

array of strings

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

bapp

source

object

This object describes the nature and behavior of the entity that is the source of the bid request upstream from the exchange. The primary purpose of this object is to define post-auction or upstream decisioning when the exchange itself does not control the final decision. A common example of this is header bidding, but it can also apply to upstream server entities such as another RTB exchange, a mediation platform, or an ad server combines direct campaigns with 3rd party demand in decisioning.

regs

object

This object contains any legal, governmental, or industry regulations that apply to the request. The coppa flag signals whether or not the request falls under the United States Federal Trade Commission’s regulations for the United States Children’s Online Privacy Protection Act (“COPPA”).

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

Headers

X-Forwarded-For

string

Client's IP address in the X-Forwarded-For

Responses

204

No Content

200OK