Retrieve dividend-index fixings across dates.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/MarketData/GetDividendIndexFixings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core",
"provider_id": "<string>",
"market_data_environment_names": [
"<string>"
],
"market_data_environment_name": "Example market data",
"dividend_index_ids": [
{
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
}
],
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.riskportal.activeviam.com/api/MarketData/GetDividendIndexFixings"
payload = {
"$type": "Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core",
"provider_id": "<string>",
"market_data_environment_names": ["<string>"],
"market_data_environment_name": "Example market data",
"dividend_index_ids": [
{
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
}
],
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z"
}
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.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core',
provider_id: '<string>',
market_data_environment_names: ['<string>'],
market_data_environment_name: 'Example market data',
dividend_index_ids: [
{
$type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
code: '<string>',
market_identification_code: '<string>'
}
],
start_date: '2023-11-07T05:31:56Z',
end_date: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.riskportal.activeviam.com/api/MarketData/GetDividendIndexFixings', 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/MarketData/GetDividendIndexFixings",
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.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core',
'provider_id' => '<string>',
'market_data_environment_names' => [
'<string>'
],
'market_data_environment_name' => 'Example market data',
'dividend_index_ids' => [
[
'$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
'code' => '<string>',
'market_identification_code' => '<string>'
]
],
'start_date' => '2023-11-07T05:31:56Z',
'end_date' => '2023-11-07T05:31:56Z'
]),
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/MarketData/GetDividendIndexFixings"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"market_data_environment_names\": [\n \"<string>\"\n ],\n \"market_data_environment_name\": \"Example market data\",\n \"dividend_index_ids\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ],\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\"\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/MarketData/GetDividendIndexFixings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"market_data_environment_names\": [\n \"<string>\"\n ],\n \"market_data_environment_name\": \"Example market data\",\n \"dividend_index_ids\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ],\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/MarketData/GetDividendIndexFixings")
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.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"market_data_environment_names\": [\n \"<string>\"\n ],\n \"market_data_environment_name\": \"Example market data\",\n \"dividend_index_ids\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ],\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
],
"dividend_index_fixings": [
{
"key": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"value": [
{
"$type": "Derivitec.Web.Core.MarketData.DividendIndexFixing, Derivitec.Web.Core",
"provider_id": "<string>",
"derivitec_created": "<string>",
"derivitec_modified": "<string>",
"uploaded_date_time": "<string>",
"derivitec_modified_by": "<string>",
"uploaded_by": "<string>",
"rolled": false,
"dividend_index_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"close": 123,
"date": "2023-11-07T05:31:56Z",
"fixing_type": "<string>"
}
]
}
]
}Retrieve dividend-index fixings across dates.
Use this operation to retrieve dividend-index fixing observations for requested indexes over an inclusive date range. Results can include data from authorised provider scopes, with Derivitec fallback, and unsupported identifiers or missing series are reported per index while other available series can still be returned.
POST
/
api
/
MarketData
/
GetDividendIndexFixings
Retrieve dividend-index fixings across dates.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/MarketData/GetDividendIndexFixings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core",
"provider_id": "<string>",
"market_data_environment_names": [
"<string>"
],
"market_data_environment_name": "Example market data",
"dividend_index_ids": [
{
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
}
],
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.riskportal.activeviam.com/api/MarketData/GetDividendIndexFixings"
payload = {
"$type": "Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core",
"provider_id": "<string>",
"market_data_environment_names": ["<string>"],
"market_data_environment_name": "Example market data",
"dividend_index_ids": [
{
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
}
],
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z"
}
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.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core',
provider_id: '<string>',
market_data_environment_names: ['<string>'],
market_data_environment_name: 'Example market data',
dividend_index_ids: [
{
$type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
code: '<string>',
market_identification_code: '<string>'
}
],
start_date: '2023-11-07T05:31:56Z',
end_date: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.riskportal.activeviam.com/api/MarketData/GetDividendIndexFixings', 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/MarketData/GetDividendIndexFixings",
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.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core',
'provider_id' => '<string>',
'market_data_environment_names' => [
'<string>'
],
'market_data_environment_name' => 'Example market data',
'dividend_index_ids' => [
[
'$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
'code' => '<string>',
'market_identification_code' => '<string>'
]
],
'start_date' => '2023-11-07T05:31:56Z',
'end_date' => '2023-11-07T05:31:56Z'
]),
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/MarketData/GetDividendIndexFixings"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"market_data_environment_names\": [\n \"<string>\"\n ],\n \"market_data_environment_name\": \"Example market data\",\n \"dividend_index_ids\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ],\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\"\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/MarketData/GetDividendIndexFixings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"market_data_environment_names\": [\n \"<string>\"\n ],\n \"market_data_environment_name\": \"Example market data\",\n \"dividend_index_ids\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ],\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/MarketData/GetDividendIndexFixings")
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.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core\",\n \"provider_id\": \"<string>\",\n \"market_data_environment_names\": [\n \"<string>\"\n ],\n \"market_data_environment_name\": \"Example market data\",\n \"dividend_index_ids\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ],\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"end_date\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
],
"dividend_index_fixings": [
{
"key": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"value": [
{
"$type": "Derivitec.Web.Core.MarketData.DividendIndexFixing, Derivitec.Web.Core",
"provider_id": "<string>",
"derivitec_created": "<string>",
"derivitec_modified": "<string>",
"uploaded_date_time": "<string>",
"derivitec_modified_by": "<string>",
"uploaded_by": "<string>",
"rolled": false,
"dividend_index_id": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"close": 123,
"date": "2023-11-07T05:31:56Z",
"fixing_type": "<string>"
}
]
}
]
}Authorizations
oauth2apikey
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
The query payload. DividendIndexIds must be non-empty; supply inclusive date-only StartDate and EndDate bounds plus optional provider or environment scope.
Queries dated dividend-index fixings by index and date range.
Available options:
Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsRequest, Derivitec.Web.Core Opaque identifier of a single market-data provider to use instead of either environment-name option.
Access classification associated with the selected market-data environment.
Available options:
view, edit, owner, blocked Names of the market-data environments to use. Do not combine this list with the single-name or provider-ID alternatives.
Single market-data environment name to use instead of market_data_environment_names or provider_id.
Example:
"Example market data"
Dividend index IDs selecting the requested dividend index fixings.
Instrument code qualified by an identifier namespace and optional market code.
- Option 1
- Option 2
Show child attributes
Show child attributes
Inclusive lower date-only boundary for the requested observations.
Inclusive upper date-only boundary for the requested observations.
Response
Returns available fixings keyed by input dividend-index identifier, together with unsupported-identifier, missing-data, or retrieval errors.
Returns dated dividend-index fixings and query errors.
Available options:
Derivitec.Web.Core.MarketData.ApiGetDividendIndexFixingsResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
Example:
true
Messages explaining operation-level failures. The collection is empty by default.
Dividend-index fixings returned by the query.
Show child attributes
Show child attributes
Was this page helpful?