Generic RTB — JSON

Hosts: {rtb_domain} is your network's RTB domain, used by the bidder endpoints; a network without a dedicated RTB domain uses its ad domain there. {ad_domain} is the network's ad-serving domain. Inside the panel both are filled in for you.

Lightweight JSON request/response shape used by integrations that pre-date OpenRTB. Returned shape varies per inventory family.

Endpoint#

GET request to https://{rtb_domain}/rtb/run.go with the placement parameters as query string. token is the SSP campaign token (required). Without it the endpoint returns 406 No Token found. Single unified endpoint — the feed (SSP campaign) settings decide the response shape (JSON / XML / OpenRTB).

Standard request

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}

Banner — with size

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}&w=300&h=250

Push — with subscription age

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}&subage=10

Mail clicks — with email

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}&email={recipient_email}

Full — every supported param

https://{rtb_domain}/rtb/run.go?token={token}&ip={client_ip}&ua={user_agent}&subid={subid}&ln={language_code}&ref={siteurl}&email={recipient_email}&w={width}&h={height}&subage={days}&subage_dt={yyyy-mm-dd}&subage_ts={unix_ts}&bidfloor={floor_cpm}&keywords={comma_separated_kw}

Query parameters#

Reference

token       SSP campaign token (required)
ip          Client IP                                 e.g. 8.8.8.8
ua          User agent string                         e.g. Mozilla/5.0 …
subid       Pass-through sub-id for tracking          (optional)
ref         Referrer / site URL                       e.g. https://site.com/page
ln          Language code                             e.g. en, nl, de
email       Recipient email (mail-click traffic only)
w, h        Banner dimensions in pixels
subage      Push: subscription age in days
subage_dt   Push: subscription date (YYYY-MM-DD)
subage_ts   Push: subscription unix timestamp
bidfloor    Override the campaign's bid floor (CPM)
keywords    Comma-separated targeting keywords

URL macros#

When you register an external SSP campaign in the admin panel, you paste the bidder's URL template into the campaign config. The gateway substitutes these {macro} tokens with the live visitor data on every outbound auction call. Same macro set used by /rtb/run.go outbound URLs and the OpenRTB exchange. Client-hints macros come from the visitor's Sec-CH-UA-* request headers (we send Accept-CH to opt browsers into reporting them).

Reference

Visitor / context
  {client_ip}                Client IP (real, post-proxy)
  {ip}                       Alias of {client_ip}
  {forwarded_for}            X-Forwarded-For chain
  {user_agent}               URL-encoded UA string
  {ua}                       Alias of {user_agent}
  {language_code}            URL-encoded browser language
  {lang}                     Alias of {language_code}
  {uniqid}                   Stable visitor id (cookie-based)
  {email}                    Recipient email (mail-click traffic only)

Page
  {page_url}                 Full page URL of the impression
  {referring_url}            Alias of {page_url}
  {ref}                      Alias of {page_url}
  {domain}                   Hostname of the page
  {domainid}                 Internal domain id

Placement
  {spaceid}                  Internal adzone id
  {pid}                      Publisher user id
  {subid}                    Pass-through sub-id
  {keywords}                 Comma-separated keywords
  {bidfloor}                 Bid floor (CPM, USD)

Client Hints (Sec-CH-UA-*)
  {ch-ua}                    Brand list (e.g. "Chromium";v="96")
  {ch-ua-full-version}       Full version (e.g. 96.0.4664.55)
  {ch-ua-full-version-list}  All brand+version pairs
  {ch-ua-arch}               CPU arch (x86, arm, …)
  {ch-ua-bitness}            32 / 64
  {ch-ua-platform}           OS name (Windows, macOS, …)
  {ch-ua-platform-version}   OS version
  {ch-ua-model}              Device model (mobile only)
  {ch-ua-mobile}             ?0 / ?1
  {ch-ua-wow64}              ?0 / ?1

Pop / Pop-under / Fullpage / Mail / Redirects#

Listing form

{
  "result": {
    "listing": [
      { "url": "url_to_follow", "bid": 0.0001 }
    ]
  }
}

Results form

{
  "results": [
    { "url": "url_to_follow", "bid": 0.0001 }
  ]
}

Link form

{
  "link": "url_to_follow",
  "cpc": 0.0001
}

Push#

Bid response

{
  "title": "Ad Title",
  "click_url": "url_here",
  "description": "Ad Description",
  "price": 0.0016,
  "image": "image_here",
  "icon": "icon_here"
}

Listing wrapper

{
  "result": {
    "listing": [{
      "title": "Ad Title",
      "url": "https://site.com",
      "description": "Ad Description",
      "bid": 0.0016,
      "pixel": "https://site.com/track",
      "image": "https://site.com/image.jpg",
      "icon": "https://site.com/icon.png"
    }]
  }
}