Skip to content

get_submission

GET
/v0/submissions/{bidder_id}

Authorizations

Parameters

Path Parameters

bidder_id
required

A UUID newtype

string format: uuid

Unique identifier of the bidder

Responses

200

A submission represents a bidder’s complete set of active authorizations and costs that are considered for auction processing.

Submissions are not first-class primitives, but intermediate objects and not persisted entities. They’re constructed from the current state of a bidder’s auths and costs when needed for an auction.

object
as_of
required

The system-time at which these lists were generated

string format: date-time
auths
required

A list of “active” auths

Array<object>

A full description of an authorization

An AuthRecord combines all the information needed to define an authorization:

  • Who owns it (bidder_id)
  • What it trades (portfolio)
  • How it can be traded (data)
  • The current accumulated trade (trade)
object
auth_id
required

A unique id for the auth

string format: uuid
bidder_id
required

The responsible bidder’s id

string format: uuid
data
One of:
null
portfolio
One of:
null
trade

The amount of cumulative trade associated to this authorization, as-of the request time

number | null format: double
version
required

The “last-modified-or-created” time as recorded by the system

string format: date-time
costs
required

A list of “active” costs

Array<object>

A full description of a cost

A CostRecord combines all the information needed to define a cost:

  • Who owns it (bidder_id)
  • Which auths it applies to (group)
  • The utility function (data)
object
bidder_id
required

The responsible bidder’s id

string format: uuid
cost_id
required

A unique id for the cost

string format: uuid
data
One of:
null
group

The group associated to the cost. Because it is not always required, some endpoints may omit its definition.

object | null
version
required

The “last-modified-or-created” time as recorded by the system

string format: date-time

500