Retrieve a bond yield curve for display.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Bond/GetBondYieldCurveData \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core",
  "market_data_environment_name": "Example market data",
  "provider_id": "<string>",
  "issuer_id": "<string>",
  "currency": "<string>",
  "debt_type": "<string>",
  "mkt_data_date": "<string>"
}
'

import requests

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

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core",
    "market_data_environment_name": "Example market data",
    "provider_id": "<string>",
    "issuer_id": "<string>",
    "currency": "<string>",
    "debt_type": "<string>",
    "mkt_data_date": "<string>"
}
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.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core',
    market_data_environment_name: 'Example market data',
    provider_id: '<string>',
    issuer_id: '<string>',
    currency: '<string>',
    debt_type: '<string>',
    mkt_data_date: '<string>'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Bond/GetBondYieldCurveData', 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/GetBondYieldCurveData",
  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.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core',
    'market_data_environment_name' => 'Example market data',
    'provider_id' => '<string>',
    'issuer_id' => '<string>',
    'currency' => '<string>',
    'debt_type' => '<string>',
    'mkt_data_date' => '<string>'
  ]),
  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/GetBondYieldCurveData"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"issuer_id\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"debt_type\": \"<string>\",\n  \"mkt_data_date\": \"<string>\"\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/GetBondYieldCurveData")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"issuer_id\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"debt_type\": \"<string>\",\n  \"mkt_data_date\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/Bond/GetBondYieldCurveData")

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.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"issuer_id\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"debt_type\": \"<string>\",\n  \"mkt_data_date\": \"<string>\"\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "provider_id": "<string>",
  "fit_date": "<string>",
  "fit_status": "<string>",
  "fit_message": "<string>",
  "is_rolled": true,
  "yield_curve_id": "<string>",
  "issuer_name": "<string>",
  "mkt_data_date": "<string>",
  "yield_curve_data_scatter": [
    {
      "maturity": 123,
      "expiry": "<string>",
      "ytm_pp": 123,
      "$type": "Derivitec.Web.Core.MarketData.BondYieldCurveDataPoint, Derivitec.Web.Core",
      "spread": 123,
      "reference_ytm_pp": 123,
      "is_ref_point": true,
      "bond_name": "<string>",
      "bond_id": "<string>",
      "bond_is_convertible": true,
      "bond_mt_m_price": "<string>"
    }
  ],
  "yield_curve_data_line_plot": [
    {
      "maturity": 123,
      "expiry": "<string>",
      "ytm_pp": 123,
      "$type": "Derivitec.Web.Core.MarketData.BondYieldCurveDataPoint, Derivitec.Web.Core",
      "spread": 123,
      "reference_ytm_pp": 123,
      "is_ref_point": true,
      "bond_name": "<string>",
      "bond_id": "<string>",
      "bond_is_convertible": true,
      "bond_mt_m_price": "<string>"
    }
  ],
  "is_referenced": true,
  "reference_yield_curve_id": "<string>",
  "reference_yield_curve_issuer_name": "<string>",
  "reference_yield_curve_currency": "<string>",
  "reference_yield_curve_debt_type": "<string>",
  "reference_yield_curve_data_line_plot": [
    {
      "maturity": 123,
      "expiry": "<string>",
      "ytm_pp": 123,
      "$type": "Derivitec.Web.Core.MarketData.BondYieldCurveDataPoint, Derivitec.Web.Core",
      "spread": 123,
      "reference_ytm_pp": 123,
      "is_ref_point": true,
      "bond_name": "<string>",
      "bond_id": "<string>",
      "bond_is_convertible": true,
      "bond_mt_m_price": "<string>"
    }
  ]
}

Retrieve a bond yield curve for display.

Use this operation to display fitted issuer yield-curve points, fit status, contributing bonds, and any reference curve. Issuer ID, currency, debt type, market-data date, and provider ID are required; the provider pipeline supplies the authorised default when no selector is sent. A future MktDataDate is replaced by the latest available market-data date. Yields and spreads use percentage-point display units and maturities are day offsets. The operation is read-only and completes before returning.

POST

api

Bond

GetBondYieldCurveData

Retrieve a bond yield curve for display.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Bond/GetBondYieldCurveData \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core",
  "market_data_environment_name": "Example market data",
  "provider_id": "<string>",
  "issuer_id": "<string>",
  "currency": "<string>",
  "debt_type": "<string>",
  "mkt_data_date": "<string>"
}
'

import requests

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

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core",
    "market_data_environment_name": "Example market data",
    "provider_id": "<string>",
    "issuer_id": "<string>",
    "currency": "<string>",
    "debt_type": "<string>",
    "mkt_data_date": "<string>"
}
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.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core',
    market_data_environment_name: 'Example market data',
    provider_id: '<string>',
    issuer_id: '<string>',
    currency: '<string>',
    debt_type: '<string>',
    mkt_data_date: '<string>'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Bond/GetBondYieldCurveData', 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/GetBondYieldCurveData",
  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.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core',
    'market_data_environment_name' => 'Example market data',
    'provider_id' => '<string>',
    'issuer_id' => '<string>',
    'currency' => '<string>',
    'debt_type' => '<string>',
    'mkt_data_date' => '<string>'
  ]),
  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/GetBondYieldCurveData"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"issuer_id\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"debt_type\": \"<string>\",\n  \"mkt_data_date\": \"<string>\"\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/GetBondYieldCurveData")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"issuer_id\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"debt_type\": \"<string>\",\n  \"mkt_data_date\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/Bond/GetBondYieldCurveData")

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.ApiGetBondYieldCurveDataRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"issuer_id\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"debt_type\": \"<string>\",\n  \"mkt_data_date\": \"<string>\"\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetBondYieldCurveDataResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "provider_id": "<string>",
  "fit_date": "<string>",
  "fit_status": "<string>",
  "fit_message": "<string>",
  "is_rolled": true,
  "yield_curve_id": "<string>",
  "issuer_name": "<string>",
  "mkt_data_date": "<string>",
  "yield_curve_data_scatter": [
    {
      "maturity": 123,
      "expiry": "<string>",
      "ytm_pp": 123,
      "$type": "Derivitec.Web.Core.MarketData.BondYieldCurveDataPoint, Derivitec.Web.Core",
      "spread": 123,
      "reference_ytm_pp": 123,
      "is_ref_point": true,
      "bond_name": "<string>",
      "bond_id": "<string>",
      "bond_is_convertible": true,
      "bond_mt_m_price": "<string>"
    }
  ],
  "yield_curve_data_line_plot": [
    {
      "maturity": 123,
      "expiry": "<string>",
      "ytm_pp": 123,
      "$type": "Derivitec.Web.Core.MarketData.BondYieldCurveDataPoint, Derivitec.Web.Core",
      "spread": 123,
      "reference_ytm_pp": 123,
      "is_ref_point": true,
      "bond_name": "<string>",
      "bond_id": "<string>",
      "bond_is_convertible": true,
      "bond_mt_m_price": "<string>"
    }
  ],
  "is_referenced": true,
  "reference_yield_curve_id": "<string>",
  "reference_yield_curve_issuer_name": "<string>",
  "reference_yield_curve_currency": "<string>",
  "reference_yield_curve_debt_type": "<string>",
  "reference_yield_curve_data_line_plot": [
    {
      "maturity": 123,
      "expiry": "<string>",
      "ytm_pp": 123,
      "$type": "Derivitec.Web.Core.MarketData.BondYieldCurveDataPoint, Derivitec.Web.Core",
      "spread": 123,
      "reference_ytm_pp": 123,
      "is_ref_point": true,
      "bond_name": "<string>",
      "bond_id": "<string>",
      "bond_is_convertible": true,
      "bond_mt_m_price": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

Non-empty IssuerId, Currency, and DebtType; date-only MktDataDate; and at most one provider selector.

Selects an issuer bond yield curve by issuer, currency, debt type, and market date.

$type

enum<string>

required

Available options:

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

issuer_id

string | null

Issuer selecting the curve.

currency

string | null

Currency that narrows the bond yield curve operation.

debt_type

string | null

Debt type used to select the issuer curve.

mkt_data_date

string

Market date of the requested issuer curve.

Response

Returns scatter and line-plot curve points, fit metadata, rolled/reference-curve details, and any missing-curve or unknown-issuer errors.

Returns fitted-curve status and plot-ready observed, fitted, and reference-curve series.

$type

enum<string>

required

Available options:

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

provider_id

string | null

Opaque identifier of the market-data provider associated with the returned data.

fit_date

string | null

Display-formatted completion time of the curve conversion, when available.

fit_status

string | null

Status reported by the curve conversion.

fit_message

string | null

Message reported by the curve conversion.

is_rolled

boolean

Whether the displayed curve was rolled from another market date.

yield_curve_id

string | null

Identifier of the displayed issuer curve.

issuer_name

string | null

Display name of the curve issuer.

mkt_data_date

string

Market date represented by the displayed curve.

yield_curve_data_scatter

object[] | null

Observed bond points shown with the displayed issuer curve.

Show child attributes

yield_curve_data_line_plot

object[] | null

Points forming the displayed issuer-curve line.

Show child attributes

is_referenced

boolean

Whether the returned bond yield curve is referenced.

reference_yield_curve_id

string | null

Identifier of the reference curve.

reference_yield_curve_issuer_name

string | null

Display name of the reference-curve issuer.

reference_yield_curve_currency

string | null

Currency dimension of the reference curve.

reference_yield_curve_debt_type

string | null

Debt-type dimension of the reference curve.

reference_yield_curve_data_line_plot

object[] | null

Plot points for the reference curve.

Show child attributes

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve a bond yield curve for display.

Authorizations

Body

Response