Skip to content

The portfolios this principal may act on.

GET
/portfolios
curl --request GET \
--url http://localhost:3001/portfolios \
--header 'Authorization: Bearer <token>'

Exists so a trading token is self-sufficient: every other trading route needs a portfolio UUID, and without this the caller has to be handed one out of band (or read the admin surface, which is exactly the authority a trading token must not have). Scope is the principal’s own grants — there is no filter to widen it.

OK

Media typeapplication/json
Array<object>

One portfolio the caller is entitled to, with the entitlement itself.

The flags are returned rather than filtered on, so a client can grey out what it cannot do instead of discovering it from a 403 mid-order.

object
base_currency
string
nullable
can_allocate
required
boolean
can_trade
required
boolean
can_view
required
boolean
code
required
string
name
required
string
portfolio_id
required
string
status
required
string

Example generated

[
{
"base_currency": "example",
"can_allocate": true,
"can_trade": true,
"can_view": true,
"code": "example",
"name": "example",
"portfolio_id": "example",
"status": "example"
}
]