Skip to content
Flow Trading Service

Replace the authorization with a new one

PUT
/v0/auths/{auth_id}

Authorizations

Parameters

Path Parameters

auth_id
required

A UUID newtype

string format: uuid

Unique identifier of the authorization

Query Parameters

portfolio
string

Implementation-dependent portfolio mode

Request Body required

One of:
object
data
required

The supported constraints for an authorization.

An AuthData defines the trading constraints for an authorization:

  • Rate constraints limit how fast a portfolio can be traded (in units per time)
  • Trade constraints limit the total accumulated trade amount over time

The rate constraints must allow the possibility of zero trade (min_rate ≤ 0 ≤ max_rate).

The trade constraints do not have this restriction, but instead, at time of specification, they should allow for the currently traded amount of the auth. If they do not, the trade constraint is implicitly expanded to include 0 at each auction, which may not be desired.

object
max_rate

The fastest rate at which the portfolio may buy (non-negative)

number | null format: double
max_trade

A maximum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)

number | null format: double
min_rate

The fastest rate at which the portfolio may sell (non-positive)

number | null format: double
min_trade

A minimum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)

number | null format: double
portfolio
required

A hashmap with deterministic ordering

object
key
additional properties
number format: double

Responses

200

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

400

401

403

404

409

415

422

500