Skip to main content
POST
Store dated ETF premiums.

Authorizations

Authorization
string
header
required

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

Body

The upload payload. Provide either ProviderId or MarketDataEnvironmentName, not both; omitting both selects the caller's organisation scope. Supply a non-empty EtfPremiums collection of ETF identifiers, date-only observation dates, and decimal premium values.

Submits dated ETF premium observations.

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

etf_premiums
object[] | null

Dated ETF premium observations to upload.

Response

Returns whether any ETF premiums were stored and errors for invalid providers, unsupported identifiers, duplicates, invalid premiums, or save failures.

Common operation outcome containing a success indicator and any error messages.

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