Retrieve bond contracts by identifier.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/Tradable/GetBonds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Web.Core.Tradables.ApiGetBondsRequest, Derivitec.Web.Core",
"market_data_environment_name": "Example market data",
"provider_id": "<string>",
"identifiers": [
{
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
}
]
}
'import requests
url = "https://api.riskportal.activeviam.com/api/Tradable/GetBonds"
payload = {
"$type": "Derivitec.Web.Core.Tradables.ApiGetBondsRequest, Derivitec.Web.Core",
"market_data_environment_name": "Example market data",
"provider_id": "<string>",
"identifiers": [
{
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<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.Tradables.ApiGetBondsRequest, Derivitec.Web.Core',
market_data_environment_name: 'Example market data',
provider_id: '<string>',
identifiers: [
{
$type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
code: '<string>',
market_identification_code: '<string>'
}
]
})
};
fetch('https://api.riskportal.activeviam.com/api/Tradable/GetBonds', 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/Tradable/GetBonds",
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.ApiGetBondsRequest, Derivitec.Web.Core',
'market_data_environment_name' => 'Example market data',
'provider_id' => '<string>',
'identifiers' => [
[
'$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
'code' => '<string>',
'market_identification_code' => '<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/Tradable/GetBonds"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Web.Core.Tradables.ApiGetBondsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"identifiers\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ]\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/Tradable/GetBonds")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Web.Core.Tradables.ApiGetBondsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"identifiers\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/Tradable/GetBonds")
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.ApiGetBondsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"identifiers\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.Tradables.ApiGetBondsResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
],
"bonds": [
{
"key": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"value": {
"$type": "Derivitec.Web.Core.Tradables.Bond, Derivitec.Web.Core",
"identifier": "<string>",
"currency": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"bond_identifier": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"par_value": 123,
"issuer": "<string>",
"issuer_id": "<string>",
"dated_date": "2023-11-07T05:31:56Z",
"first_coupon_date": "2023-11-07T05:31:56Z",
"penultimate_coupon_date": "2023-11-07T05:31:56Z",
"maturity_date": "2023-11-07T05:31:56Z",
"roll_date": "2023-11-07T05:31:56Z",
"end_to_end": true,
"business_day_convention": "actual",
"bond_coupon_frequency": "zero_coupon",
"bond_coupon_type": "fixed",
"bond_day_count_convention": "actual_actual_icma",
"settlement_lag": 123,
"coupon_rate": 123,
"calendar": "<string>",
"next_coupon_index": 123,
"bond_capitalisation_provision": {
"$type": "Derivitec.Web.Core.StaticData.BondCapitalisationProvision, Derivitec.Web.Core",
"capitalisation_dates": [
"2023-11-07T05:31:56Z"
],
"capitalisation_rates": [
123
]
},
"bond_extension_provision": {
"$type": "Derivitec.Web.Core.StaticData.BondExtensionProvision, Derivitec.Web.Core",
"extension_dates": [
"2023-11-07T05:31:56Z"
],
"extended_maturity_dates": [
"2023-11-07T05:31:56Z"
],
"extended_redemption_values": [
123
],
"issuer_extension": [
true
]
},
"bond_call_provision": {
"$type": "Derivitec.Web.Core.StaticData.BondCallProvision, Derivitec.Web.Core",
"dates": [
"2023-11-07T05:31:56Z"
],
"redemption_values": [
123
],
"exercise_style": "european"
},
"bond_put_provision": {
"$type": "Derivitec.Web.Core.StaticData.BondPutProvision, Derivitec.Web.Core",
"dates": [
"2023-11-07T05:31:56Z"
],
"redemption_values": [
123
],
"exercise_style": "european"
},
"tranche_definition": {
"$type": "Derivitec.Web.Core.StaticData.TrancheDefinition, Derivitec.Web.Core",
"tranche_id": "<string>",
"attachment": 123,
"detachment": 123,
"senior_principal_factor": 123,
"tranche_principal_factor": 123,
"junior_principal_factor": 123,
"amortisation_start_date": "2023-11-07T05:31:56Z",
"amortisation_type": "pro_rata",
"cleanup_call_threshold": 123
},
"bond_coupons": [
{
"$type": "Derivitec.Web.Core.StaticData.BondCoupon, Derivitec.Web.Core",
"coupon_leg_start_date": "2023-11-07T05:31:56Z",
"coupon_leg_end_date": "2023-11-07T05:31:56Z",
"coupon_leg_first_coupon_date": "2023-11-07T05:31:56Z",
"coupon_leg_penultimate_coupon_date": "2023-11-07T05:31:56Z",
"coupon_type": "fixed",
"coupon_frequency": "zero_coupon",
"fixed_coupon_rate": 123,
"coupon_index_id": "<string>",
"index_fixing_lag": 123,
"index_multiplier": 123,
"coupon_floor": 123,
"coupon_cap": 123
}
],
"redemption_rate": 123,
"debt_type": "senior",
"is_trs": true,
"traded_price": 123,
"funding_currency": "<string>",
"trs_expiration_date": "2023-11-07T05:31:56Z"
}
}
]
}Retrieve bond contracts by identifier.
Returns bond contract definitions for requested instrument identifiers in one accessible market-data environment. This is read-only.
POST
/
api
/
Tradable
/
GetBonds
Retrieve bond contracts by identifier.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/Tradable/GetBonds \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Web.Core.Tradables.ApiGetBondsRequest, Derivitec.Web.Core",
"market_data_environment_name": "Example market data",
"provider_id": "<string>",
"identifiers": [
{
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<string>"
}
]
}
'import requests
url = "https://api.riskportal.activeviam.com/api/Tradable/GetBonds"
payload = {
"$type": "Derivitec.Web.Core.Tradables.ApiGetBondsRequest, Derivitec.Web.Core",
"market_data_environment_name": "Example market data",
"provider_id": "<string>",
"identifiers": [
{
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"market_identification_code": "<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.Tradables.ApiGetBondsRequest, Derivitec.Web.Core',
market_data_environment_name: 'Example market data',
provider_id: '<string>',
identifiers: [
{
$type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
code: '<string>',
market_identification_code: '<string>'
}
]
})
};
fetch('https://api.riskportal.activeviam.com/api/Tradable/GetBonds', 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/Tradable/GetBonds",
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.ApiGetBondsRequest, Derivitec.Web.Core',
'market_data_environment_name' => 'Example market data',
'provider_id' => '<string>',
'identifiers' => [
[
'$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
'code' => '<string>',
'market_identification_code' => '<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/Tradable/GetBonds"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Web.Core.Tradables.ApiGetBondsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"identifiers\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ]\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/Tradable/GetBonds")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Web.Core.Tradables.ApiGetBondsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"identifiers\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/Tradable/GetBonds")
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.ApiGetBondsRequest, Derivitec.Web.Core\",\n \"market_data_environment_name\": \"Example market data\",\n \"provider_id\": \"<string>\",\n \"identifiers\": [\n {\n \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n \"code\": \"<string>\",\n \"market_identification_code\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.Tradables.ApiGetBondsResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
],
"bonds": [
{
"key": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"value": {
"$type": "Derivitec.Web.Core.Tradables.Bond, Derivitec.Web.Core",
"identifier": "<string>",
"currency": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"bond_identifier": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"par_value": 123,
"issuer": "<string>",
"issuer_id": "<string>",
"dated_date": "2023-11-07T05:31:56Z",
"first_coupon_date": "2023-11-07T05:31:56Z",
"penultimate_coupon_date": "2023-11-07T05:31:56Z",
"maturity_date": "2023-11-07T05:31:56Z",
"roll_date": "2023-11-07T05:31:56Z",
"end_to_end": true,
"business_day_convention": "actual",
"bond_coupon_frequency": "zero_coupon",
"bond_coupon_type": "fixed",
"bond_day_count_convention": "actual_actual_icma",
"settlement_lag": 123,
"coupon_rate": 123,
"calendar": "<string>",
"next_coupon_index": 123,
"bond_capitalisation_provision": {
"$type": "Derivitec.Web.Core.StaticData.BondCapitalisationProvision, Derivitec.Web.Core",
"capitalisation_dates": [
"2023-11-07T05:31:56Z"
],
"capitalisation_rates": [
123
]
},
"bond_extension_provision": {
"$type": "Derivitec.Web.Core.StaticData.BondExtensionProvision, Derivitec.Web.Core",
"extension_dates": [
"2023-11-07T05:31:56Z"
],
"extended_maturity_dates": [
"2023-11-07T05:31:56Z"
],
"extended_redemption_values": [
123
],
"issuer_extension": [
true
]
},
"bond_call_provision": {
"$type": "Derivitec.Web.Core.StaticData.BondCallProvision, Derivitec.Web.Core",
"dates": [
"2023-11-07T05:31:56Z"
],
"redemption_values": [
123
],
"exercise_style": "european"
},
"bond_put_provision": {
"$type": "Derivitec.Web.Core.StaticData.BondPutProvision, Derivitec.Web.Core",
"dates": [
"2023-11-07T05:31:56Z"
],
"redemption_values": [
123
],
"exercise_style": "european"
},
"tranche_definition": {
"$type": "Derivitec.Web.Core.StaticData.TrancheDefinition, Derivitec.Web.Core",
"tranche_id": "<string>",
"attachment": 123,
"detachment": 123,
"senior_principal_factor": 123,
"tranche_principal_factor": 123,
"junior_principal_factor": 123,
"amortisation_start_date": "2023-11-07T05:31:56Z",
"amortisation_type": "pro_rata",
"cleanup_call_threshold": 123
},
"bond_coupons": [
{
"$type": "Derivitec.Web.Core.StaticData.BondCoupon, Derivitec.Web.Core",
"coupon_leg_start_date": "2023-11-07T05:31:56Z",
"coupon_leg_end_date": "2023-11-07T05:31:56Z",
"coupon_leg_first_coupon_date": "2023-11-07T05:31:56Z",
"coupon_leg_penultimate_coupon_date": "2023-11-07T05:31:56Z",
"coupon_type": "fixed",
"coupon_frequency": "zero_coupon",
"fixed_coupon_rate": 123,
"coupon_index_id": "<string>",
"index_fixing_lag": 123,
"index_multiplier": 123,
"coupon_floor": 123,
"coupon_cap": 123
}
],
"redemption_rate": 123,
"debt_type": "senior",
"is_trs": true,
"traded_price": 123,
"funding_currency": "<string>",
"trs_expiration_date": "2023-11-07T05:31:56Z"
}
}
]
}Authorizations
oauth2apikey
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
JSON request with non-empty Identifiers and at most one accessible market-data environment selected by name or identifier.
Instrument identifiers used to retrieve bond contract definitions.
Available options:
Derivitec.Web.Core.Tradables.ApiGetBondsRequest, Derivitec.Web.Core Name of the market-data environment to use. Supply either this name or provider_id, not both.
Example:
"Example market data"
Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.
Identifiers of the bonds to retrieve.
Instrument code qualified by an identifier namespace and optional market code.
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Returns matched bonds and errors.
Bond definitions matched to requested instrument identifiers.
Available options:
Derivitec.Web.Core.Tradables.ApiGetBondsResponse, 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.
Requested instrument identifiers paired with their bond definitions.
Show child attributes
Show child attributes
Was this page helpful?