Retrieve projected equity dividends.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core",
  "identifier": {
    "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
    "code": "<string>",
    "market_identification_code": "<string>"
  },
  "market_date": "2023-11-07T05:31:56Z",
  "provider_id": "<string>",
  "market_data_environment_names": [
    "<string>"
  ],
  "market_data_environment_name": "Example market data"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve"

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core",
    "identifier": {
        "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
        "code": "<string>",
        "market_identification_code": "<string>"
    },
    "market_date": "2023-11-07T05:31:56Z",
    "provider_id": "<string>",
    "market_data_environment_names": ["<string>"],
    "market_data_environment_name": "Example market data"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    $type: 'Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core',
    identifier: {
      $type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
      code: '<string>',
      market_identification_code: '<string>'
    },
    market_date: '2023-11-07T05:31:56Z',
    provider_id: '<string>',
    market_data_environment_names: ['<string>'],
    market_data_environment_name: 'Example market data'
  })
};

fetch('https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '$type' => 'Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core',
    'identifier' => [
        '$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
        'code' => '<string>',
        'market_identification_code' => '<string>'
    ],
    'market_date' => '2023-11-07T05:31:56Z',
    'provider_id' => '<string>',
    'market_data_environment_names' => [
        '<string>'
    ],
    'market_data_environment_name' => 'Example market data'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}"

response = http.request(request)
puts response.read_body

{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetDividendCurveResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "curve_data": [
    {
      "$type": "Derivitec.Web.Core.MarketData.DividendPoint, Derivitec.Web.Core",
      "all_in_rate": 123,
      "announcement_date": "2023-11-07T05:31:56Z",
      "cash_dividend": 123,
      "confirmed": true,
      "dividend_yield": 123,
      "ex_date": "2023-11-07T05:31:56Z",
      "pay_date": "2023-11-07T05:31:56Z",
      "record_date": "2023-11-07T05:31:56Z",
      "tax_rate": 123,
      "currency": "<string>",
      "gross_div": 123,
      "forward": 123,
      "net_div": 123,
      "dividend_type": "regular",
      "withholding_tax": 123,
      "constituent_ric": "<string>",
      "constituent_bbg_code": "<string>",
      "id": "<string>",
      "uploaded_by": "<string>",
      "uploaded_date_time": "2023-11-07T05:31:56Z"
    }
  ]
}

Retrieve projected equity dividends.

Use this operation for dividends from the requested market date onward for one equity. Results are ordered by ex-date and can include cash amount, yield, currency, dates, confirmation/type, withholding tax, constituent codes, upload attribution, and a forward level for yield-based entries. Both Identifier and MarketDate are mandatory. Provider/environment selection determines the requested contribution scope. The operation is read-only and completes before returning.

POST

api

EquityDividend

GetDividendCurve

Retrieve projected equity dividends.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core",
  "identifier": {
    "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
    "code": "<string>",
    "market_identification_code": "<string>"
  },
  "market_date": "2023-11-07T05:31:56Z",
  "provider_id": "<string>",
  "market_data_environment_names": [
    "<string>"
  ],
  "market_data_environment_name": "Example market data"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve"

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core",
    "identifier": {
        "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
        "code": "<string>",
        "market_identification_code": "<string>"
    },
    "market_date": "2023-11-07T05:31:56Z",
    "provider_id": "<string>",
    "market_data_environment_names": ["<string>"],
    "market_data_environment_name": "Example market data"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    $type: 'Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core',
    identifier: {
      $type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
      code: '<string>',
      market_identification_code: '<string>'
    },
    market_date: '2023-11-07T05:31:56Z',
    provider_id: '<string>',
    market_data_environment_names: ['<string>'],
    market_data_environment_name: 'Example market data'
  })
};

fetch('https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '$type' => 'Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core',
    'identifier' => [
        '$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
        'code' => '<string>',
        'market_identification_code' => '<string>'
    ],
    'market_date' => '2023-11-07T05:31:56Z',
    'provider_id' => '<string>',
    'market_data_environment_names' => [
        '<string>'
    ],
    'market_data_environment_name' => 'Example market data'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/EquityDividend/GetDividendCurve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}"

response = http.request(request)
puts response.read_body

{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetDividendCurveResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "curve_data": [
    {
      "$type": "Derivitec.Web.Core.MarketData.DividendPoint, Derivitec.Web.Core",
      "all_in_rate": 123,
      "announcement_date": "2023-11-07T05:31:56Z",
      "cash_dividend": 123,
      "confirmed": true,
      "dividend_yield": 123,
      "ex_date": "2023-11-07T05:31:56Z",
      "pay_date": "2023-11-07T05:31:56Z",
      "record_date": "2023-11-07T05:31:56Z",
      "tax_rate": 123,
      "currency": "<string>",
      "gross_div": 123,
      "forward": 123,
      "net_div": 123,
      "dividend_type": "regular",
      "withholding_tax": 123,
      "constituent_ric": "<string>",
      "constituent_bbg_code": "<string>",
      "id": "<string>",
      "uploaded_by": "<string>",
      "uploaded_date_time": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

A supported, non-empty equity Identifier, a non-default date-only MarketDate, and one authorised provider-selector form.

Selects an equity and market-data date for projected dividend payments.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.MarketData.ApiGetDividendCurveRequest, Derivitec.Web.Core

identifier

object

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

Option 1
Option 2

Show child attributes

market_date

string<date-time>

Market date used by the derived request.

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"

Response

Returns projected dividend points ordered by ex-date, or validation, identifier, and market-data errors.

Returns projected dividend payments for the selected equity.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.MarketData.ApiGetDividendCurveResponse, 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.

curve_data

object[] | null

Projected dividend payments ordered by ascending ex-dividend date.

Show child attributes

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve projected equity dividends.

Authorizations

Body

Response