Skip to main content
POST
List projected-dividend uploads by environment.

Authorizations

Authorization
string
header
required

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

Body

The metadata query. Supply a date-only MarketDate; Identifiers optionally limits equities, and MarketDataEnvironmentNames optionally limits authorised non-Derivitec environments.

Queries projected dividend schedules for one environment and market date.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetProjectedDividendsForEnvRequest, Derivitec.Web.Core
provider_id
string | null

Opaque identifier of a single market-data provider to use instead of either environment-name option.

entity_access_type
enum<string>

Access classification associated with the selected market-data environment.

Available options:
view,
edit,
owner,
blocked
market_data_environment_names
string[] | null

Names of the market-data environments to use. Do not combine this list with the single-name or provider-ID alternatives.

market_data_environment_name
string | null

Single market-data environment name to use instead of market_data_environment_names or provider_id.

Example:

"Example market data"

market_date
string<date-time>

Market date on which projected dividends are requested.

identifiers
object[] | null

Instrument selectors whose projected dividends are requested.

Instrument code qualified by an identifier namespace and optional market code.

Response

Returns environment, equity, uploader, upload-time, and rolled-state metadata, or organisation, date, and retrieval errors.

Returns projected dividend schedules for the selected environment and date.

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

dividend_data
object[] | null

Projected dividend schedules returned by the query.