Skip to main content
POST
Retrieve an aggregated portfolio position table.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

JSON request with a non-empty PortfolioName, optional PortfolioType when unambiguous, and PortfolioDate as an ISO-8601 date/time whose calendar date is the position date. No default applies when the date is omitted.

Portfolio and calendar date used to retrieve an aggregated position table.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Positions.ApiGetPortfolioTableRequest, Derivitec.Web.Core
portfolio_name
string | null

Name of the portfolio to select. The value must not be null or empty.

Example:

"Example portfolio"

portfolio_type
enum<string> | null

Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.

Available options:
derivitec,
enfusion,
orchestrade,
liquidity_book,
maia,
fund_studio,
not_set
portfolio_date
string<date-time>

Calendar date whose end of day in the caller's time zone defines the portfolio snapshot.

Response

Returns the portfolio data table, or an unsuccessful payload when the named portfolio is unavailable to the caller.

Aggregated position table returned for the selected portfolio date.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Positions.ApiGetPortfolioTableResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

data_table
object[] | null

JSON row table using the caller's organisation-specific columns and grouping when configured.