Retrieve the requested authorization, if possible

GET

/v0/auths/{auth_id}

Authorizations

• jwt

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

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

null

object

The constraint data for the authorization

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

One of:

null

null

object

The portfolio associated to the auth. Due to the expected size, this portfolio may be omitted from certain endpoints.

object

key

additional properties

number format: double

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

401

403

404

500