Retrieve a bond coupon schedule.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Bond/GetCoupons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core",
  "market_data_environment_name": "Example market data",
  "provider_id": "<string>",
  "mkt_data_date": "2023-11-07T05:31:56Z",
  "pricing_date": "2023-11-07T05:31:56Z",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/Bond/GetCoupons"

payload = {
    "$type": "Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core",
    "market_data_environment_name": "Example market data",
    "provider_id": "<string>",
    "mkt_data_date": "2023-11-07T05:31:56Z",
    "pricing_date": "2023-11-07T05:31:56Z",
    "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.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core',
    market_data_environment_name: 'Example market data',
    provider_id: '<string>',
    mkt_data_date: '2023-11-07T05:31:56Z',
    pricing_date: '2023-11-07T05:31:56Z',
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Bond/GetCoupons', 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/Bond/GetCoupons",
  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.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core',
    'market_data_environment_name' => 'Example market data',
    'provider_id' => '<string>',
    'mkt_data_date' => '2023-11-07T05:31:56Z',
    'pricing_date' => '2023-11-07T05:31:56Z',
    '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/Bond/GetCoupons"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"mkt_data_date\": \"2023-11-07T05:31:56Z\",\n  \"pricing_date\": \"2023-11-07T05:31:56Z\",\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/Bond/GetCoupons")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"mkt_data_date\": \"2023-11-07T05:31:56Z\",\n  \"pricing_date\": \"2023-11-07T05:31:56Z\",\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/Bond/GetCoupons")

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.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"mkt_data_date\": \"2023-11-07T05:31:56Z\",\n  \"pricing_date\": \"2023-11-07T05:31:56Z\",\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.Tradables.ApiGetCouponsResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "coupon_dates": [
    "2023-11-07T05:31:56Z"
  ],
  "coupons": [
    123
  ]
}

Retrieve a bond coupon schedule.

Use this operation to retrieve coupon dates and values for one code-specified bond over a requested range. Bond, MktDataDate, PricingDate, StartDate, and EndDate are required. Omitting provider selection uses the shared Derivitec provider for this request. All date/time inputs are interpreted as calendar dates; no start/end ordering rule is established by this action. It is read-only and completes the schedule before returning.

POST

api

Bond

GetCoupons

Retrieve a bond coupon schedule.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Bond/GetCoupons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core",
  "market_data_environment_name": "Example market data",
  "provider_id": "<string>",
  "mkt_data_date": "2023-11-07T05:31:56Z",
  "pricing_date": "2023-11-07T05:31:56Z",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/Bond/GetCoupons"

payload = {
    "$type": "Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core",
    "market_data_environment_name": "Example market data",
    "provider_id": "<string>",
    "mkt_data_date": "2023-11-07T05:31:56Z",
    "pricing_date": "2023-11-07T05:31:56Z",
    "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.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core',
    market_data_environment_name: 'Example market data',
    provider_id: '<string>',
    mkt_data_date: '2023-11-07T05:31:56Z',
    pricing_date: '2023-11-07T05:31:56Z',
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Bond/GetCoupons', 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/Bond/GetCoupons",
  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.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core',
    'market_data_environment_name' => 'Example market data',
    'provider_id' => '<string>',
    'mkt_data_date' => '2023-11-07T05:31:56Z',
    'pricing_date' => '2023-11-07T05:31:56Z',
    '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/Bond/GetCoupons"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"mkt_data_date\": \"2023-11-07T05:31:56Z\",\n  \"pricing_date\": \"2023-11-07T05:31:56Z\",\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/Bond/GetCoupons")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"mkt_data_date\": \"2023-11-07T05:31:56Z\",\n  \"pricing_date\": \"2023-11-07T05:31:56Z\",\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/Bond/GetCoupons")

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.Tradables.ApiGetCouponsRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"mkt_data_date\": \"2023-11-07T05:31:56Z\",\n  \"pricing_date\": \"2023-11-07T05:31:56Z\",\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.Tradables.ApiGetCouponsResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "coupon_dates": [
    "2023-11-07T05:31:56Z"
  ],
  "coupons": [
    123
  ]
}

Authorizations

Authorization

string

header

required

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

Body

The bond InstrumentIdentifier, four calendar-date inputs, and at most one provider selector: ProviderId or MarketDataEnvironmentName.

Code-specified bond, valuation dates, and date interval used to request coupon amounts.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.Tradables.ApiGetCouponsRequest, 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.

bond

object

Bond contract selected by an instrument code rather than fully specified bond terms.

Show child attributes

mkt_data_date

string<date-time>

Date of market data used to determine coupon amounts.

pricing_date

string<date-time>

Date on which the bond is evaluated for the coupon request.

start_date

string<date-time>

Lower date bound of the requested coupon interval; inclusivity is not defined here.

end_date

string<date-time>

Upper date bound of the requested coupon interval; inclusivity is not defined here.

Response

Returns parallel coupon-date and coupon-value collections, or validation and domain errors in the response payload.

Coupon dates and amounts returned for the requested bond.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.Tradables.ApiGetCouponsResponse, 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.

coupon_dates

string<date-time>[] | null

Dates of the returned coupon amounts.

coupons

number<double>[] | null

Returned coupon amounts; currency, units, and correspondence to dates are not defined here.

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve a bond coupon schedule.

Authorizations

Body

Response