put_submission
Authorizations
Parameters
Path Parameters
A UUID newtype
Unique identifier of the bidder
Request Body required
The submission endpoint embeds a mini-CRUD interface, accordingly we need a type to embed the CRUD operations.
object
List of auth entries for this submission
Create a new authorization with the specified portfolio and data
object
The unique identifier for the authorization
The authorization data
object
The fastest rate at which the portfolio may buy (non-negative)
A maximum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)
The fastest rate at which the portfolio may sell (non-positive)
A minimum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)
The portfolio associated with this authorization
object
Update an existing authorization with new data
object
The unique identifier for the authorization
The authorization data
object
The fastest rate at which the portfolio may buy (non-negative)
A maximum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)
The fastest rate at which the portfolio may sell (non-positive)
A minimum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)
Read an existing authorization
object
The unique identifier for the authorization
List of cost entries for this submission
Create a new cost with the specified group and data
object
The unique identifier for the cost
A representation of a piecewise-linear, weakly monotone decreasing demand curve
Demand curves define a bidder’s willingness to pay for different quantities of a good. In flow trading, these curves must be:
- Piecewise-linear (defined by a sequence of points)
- Weakly monotone decreasing (price non-increasing as rate increases)
- Include the point rate=0 in their domain (must allow zero trade)
A representation of a point for use in defining piecewise-linear curves
Each point consists of:
- A rate (quantity per time unit)
- A price (value per unit)
Points are used to define the vertices of piecewise-linear demand curves.
object
The price (value per unit) coordinate
The rate (quantity per time) coordinate
A representation of a flat demand curve supporting interval, half-line, and full-line trading domains
A constant curve represents a fixed price for trades within a specified rate range. This can be used to express indifference to (potentially unbounded) trade rates at a specific price.
The sign convention follows flow trading standards:
- min_rate ≤ 0 (non-positive): maximum selling rate
- max_rate ≥ 0 (non-negative): maximum buying rate
object
The fastest rate at which the portfolio may buy (non-negative)
The fastest rate at which the portfolio may sell (non-positive)
The fixed price at which trades within the rate range are valued
The group associated with this cost
object
Update an existing cost with new data
object
The unique identifier for the cost
A representation of a piecewise-linear, weakly monotone decreasing demand curve
Demand curves define a bidder’s willingness to pay for different quantities of a good. In flow trading, these curves must be:
- Piecewise-linear (defined by a sequence of points)
- Weakly monotone decreasing (price non-increasing as rate increases)
- Include the point rate=0 in their domain (must allow zero trade)
A representation of a point for use in defining piecewise-linear curves
Each point consists of:
- A rate (quantity per time unit)
- A price (value per unit)
Points are used to define the vertices of piecewise-linear demand curves.
object
The price (value per unit) coordinate
The rate (quantity per time) coordinate
A representation of a flat demand curve supporting interval, half-line, and full-line trading domains
A constant curve represents a fixed price for trades within a specified rate range. This can be used to express indifference to (potentially unbounded) trade rates at a specific price.
The sign convention follows flow trading standards:
- min_rate ≤ 0 (non-positive): maximum selling rate
- max_rate ≥ 0 (non-negative): maximum buying rate
object
The fastest rate at which the portfolio may buy (non-negative)
The fastest rate at which the portfolio may sell (non-positive)
The fixed price at which trades within the rate range are valued
Read an existing cost
object
The unique identifier for the cost
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
The system-time at which these lists were generated
A list of “active” auths
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
A unique id for the auth
The responsible bidder’s id
The constraint data for the authorization
object
The fastest rate at which the portfolio may buy (non-negative)
A maximum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)
The fastest rate at which the portfolio may sell (non-positive)
A minimum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)
The amount of cumulative trade associated to this authorization, as-of the request time
The “last-modified-or-created” time as recorded by the system
A list of “active” costs
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
The responsible bidder’s id
A unique id for the cost
A representation of a piecewise-linear, weakly monotone decreasing demand curve
Demand curves define a bidder’s willingness to pay for different quantities of a good. In flow trading, these curves must be:
- Piecewise-linear (defined by a sequence of points)
- Weakly monotone decreasing (price non-increasing as rate increases)
- Include the point rate=0 in their domain (must allow zero trade)
A representation of a point for use in defining piecewise-linear curves
Each point consists of:
- A rate (quantity per time unit)
- A price (value per unit)
Points are used to define the vertices of piecewise-linear demand curves.
object
The price (value per unit) coordinate
The rate (quantity per time) coordinate
A representation of a flat demand curve supporting interval, half-line, and full-line trading domains
A constant curve represents a fixed price for trades within a specified rate range. This can be used to express indifference to (potentially unbounded) trade rates at a specific price.
The sign convention follows flow trading standards:
- min_rate ≤ 0 (non-positive): maximum selling rate
- max_rate ≥ 0 (non-negative): maximum buying rate
object
The fastest rate at which the portfolio may buy (non-negative)
The fastest rate at which the portfolio may sell (non-positive)
The fixed price at which trades within the rate range are valued
The group associated to the cost. Because it is not always required, some endpoints may omit its definition.
The “last-modified-or-created” time as recorded by the system