Skip to main content
POST
Store index or ETF component sets.

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. IndexComponentData must be non-empty; rows contain index or ETF scope, component identifier, market date, weights or shares, and optional divisor, index price, and notes. ConstituentSpot is accepted but is not used by this upload.

Submits dated index-component sets.

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

index_component_data
object[] | null

Dated index-component sets to upload.

use_best_effort
boolean

Requests independent handling of input records when one cannot be processed; defaults to false.

Response

Returns whether component sets and divisors were stored and errors for invalid providers, identifiers, coverage, duplicates, weights, shares, prices, or divisors. Scheduled conversion results are not included; conversion may still be pending or running.

Returns the success flag and error messages from an index-component upload.

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