Sign in

v1

latestOpenAPI 3.1.02026-07-24173271.4 KB

Bid Check

Get a real-time Sovrn bid on your click traffic.

get/api/bid

Query parameters

keystring required

Site Commerce API Key for the site or traffic source where the click originated. Use the API Key that corresponds to the site, app, or traffic source sending the click so the bid is evaluated and attributed correctly.

outstring uri required

Destination URL for the click. This value must be URL-encoded when placed in the query string.

ipstring required

The real end user's IP address. IPv4 and IPv6 are supported. Pass the end user's actual IP address, not the IP address of your server. This value must match the user who is redirected through Sovrn for the bid to be valid.

userAgentstring required

The real end user's browser User-Agent string. Pass the end user's actual User-Agent, not the User-Agent of your server. This value must match the user who is redirected through Sovrn for the bid to be valid. This value must be URL-encoded when placed in the query string.

referrerUrlstring uri

Page URL where the click originated. This value must be URL-encoded when placed in the query string.

subIdstring uri

Fully qualified SubID URL used to associate the click with a child campaign, placement, domain, or publisher under the parent API Key. If the SubID does not already exist, Sovrn will create it. This value must be URL-encoded when placed in the query string.

bidFloornumber float

Minimum acceptable bid, in USD, expressed as a decimal. For example, 0.01 means one cent. When provided, bids below this value return affiliated: false. If omitted, no minimum bid floor is applied.

includeCpaboolean

When true, CPA offers are considered alongside CPC bids. If a CPA offer wins, the response pricing will be CPA. If omitted, only CPC bids are considered.

cuidstring

An identifier of your choosing used to associate the click with a user, page, campaign, or event. Use only letters, numbers, hyphens, and underscores. Maximum 2048 characters.

utm_sourcestring

Identifies the source of the traffic, such as a website, newsletter, or social platform. Use only letters, numbers, hyphens, and underscores.

utm_mediumstring

Identifies the marketing medium, such as email, social, or banner. Use only letters, numbers, hyphens, and underscores.

utm_campaignstring

Identifies the campaign name, promotion, or initiative. Use only letters, numbers, hyphens, and underscores.

utm_termstring

Identifies paid search keywords or targeting terms. Use only letters, numbers, hyphens, and underscores.

utm_contentstring

Differentiates similar links or placements on the same page. Use only letters, numbers, hyphens, and underscores.

gdprAppliesboolean

Indicates whether GDPR applies to the user. If omitted, Sovrn determines whether GDPR applies based on the user's IP address.

gdprConsentstring

Raw GDPR consent string for the user, when applicable.

ccpaConsentstring

Raw CCPA consent string for the user, when applicable.

gppConsentstring

Raw GPP consent string for the user, when applicable.

Response

Success — bid response returned.

OR

Example response

{
  "affiliated": true,
  "pricing": "CPC",
  "eepc": 0.05725,
  "url": "https://redirect.viglink.com?u=https%3A%2F%2Fexample-merchant.com&key=YOUR_API_KEY",
  "expireInMs": 250
}