---
title: "Bid Check"
method: GET
path: "/api/bid"
---

# Bid Check

`GET /api/bid`

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

## Query parameters

- `key` string, required
- `out` string, uri, required
- `ip` string, required
- `userAgent` string, required
- `referrerUrl` string, uri
- `subId` string, uri
- `bidFloor` number, float
- `includeCpa` boolean
- `cuid` string
- `utm_source` string
- `utm_medium` string
- `utm_campaign` string
- `utm_term` string
- `utm_content` string
- `gdprApplies` boolean
- `gdprConsent` string
- `ccpaConsent` string
- `gppConsent` string

## Response `200`

Success — bid response returned.

- union
  - BidWin — Returned when Sovrn returns a bid or offer for the click.
    - `affiliated` boolean, required — `true` when Sovrn returns a bid or offer for the click.
    - `pricing` 'CPC' | 'CPA', required — Pricing model of the winning bid or offer. `CPC` is a real-time bid win. `CPA` is returned when `includeCpa=true` and a CPA offer wins.
    - `eepc` number, float, required — Expected earnings per click, in USD. This value is returned after Sovrn's revenue share is deducted. For CPC bids, this is the rate you can earn by routing the click through Sovrn before the bid expires. For CPA offers, this is the average amount Sovrn expects you to earn per click and is not guaranteed for an individual click.
    - `url` string, uri, required — Sovrn redirect URL to use if you route the click through Sovrn. Visiting this URL tracks the click and forwards the user to the destination URL.
    - `expireInMs` integer — Length of time the returned bid is valid, in milliseconds. Returned for CPC wins only. If you redirect the user after the bid expires, the click is still tracked and affiliated through standard link optimization at the current market rate.
  - BidNoFill — Returned when there is no eligible bid, the destination URL is not monetizable, or the available bid is below the submitted bid floor.
    - `affiliated` boolean, required — `false` when there is no eligible bid, the destination URL is not monetizable, or the available bid is below the submitted `bidFloor`.

## Other responses

- `400` — Bad Request — one or more required fields are missing or malformed.
- `401` — Unauthorized — the provided `key` is not a valid Commerce API Key.
- `500` — Internal Server Error.

---

[API](https://skmtc.net/sovrn/apis/rest.md) · [All operations](https://skmtc.net/sovrn/apis/rest/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sovrn/rest/versions/cb783ced960d/schema)