Skip to main content
POST
Retrieve contracts held by a portfolio.

Authorizations

Authorization
string
header
required

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

Body

JSON request with non-empty PortfolioName, optional PortfolioType when unambiguous, meaningful AsOfDateTime, and at most one accessible market-data environment selected by name or identifier. No date default applies.

Portfolio and point-in-time selection used to retrieve its tradable contracts.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Tradables.ApiGetContractsFromPortfolioRequest, Derivitec.Web.Core
market_data_environment_name
string | null

Name of the market-data environment to use. Supply either this name or provider_id, not both.

Example:

"Example market data"

provider_id
string | null

Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.

portfolio_name
string | null

Name of the portfolio whose contracts are requested.

as_of_date_time
string<date-time>

Date whose end-of-day portfolio snapshot supplies the contracts; the time-of-day is discarded and request context supplies the timezone.

portfolio_type
enum<string> | null

Optional source classification of the selected portfolio.

Available options:
derivitec,
enfusion,
orchestrade,
liquidity_book,
maia,
fund_studio,
not_set

Response

Returns contracts, or an unsuccessful payload with portfolio or contract errors.

Response envelope for tradable contracts in the selected portfolio.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Tradables.ApiGetContractsFromPortfolioResponse, 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.

contracts
object[] | null

Resolved contracts with their tradable identifiers and display context when the request succeeds.