Retrieve bond price observations.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/MarketData/GetBondData \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetBondDataRequest, 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>"
    }
  ],
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "return_contributed_data": true
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/MarketData/GetBondData"

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiGetBondDataRequest, 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>"
        }
    ],
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "return_contributed_data": True
}
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.ApiGetBondDataRequest, 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>'
      }
    ],
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    return_contributed_data: true
  })
};

fetch('https://api.riskportal.activeviam.com/api/MarketData/GetBondData', 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/GetBondData",
  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.ApiGetBondDataRequest, 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>'
        ]
    ],
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'return_contributed_data' => true
  ]),
  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/GetBondData"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetBondDataRequest, 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  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"return_contributed_data\": true\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/GetBondData")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetBondDataRequest, 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  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"return_contributed_data\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/MarketData/GetBondData")

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.ApiGetBondDataRequest, 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  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"return_contributed_data\": true\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetBondDataResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "bond_data": [
    {
      "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.BondData, 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,
          "bond_id": "<string>",
          "close": 123,
          "currency": "<string>",
          "date": "2023-11-07T05:31:56Z",
          "high": 123,
          "low": 123,
          "open": 123,
          "contributor": "<string>",
          "volume": 123,
          "liquidity_score": 123,
          "is_live_price": true
        }
      ]
    }
  ]
}

Retrieve bond price observations.

Use this operation to retrieve dated price observations for requested bonds over an inclusive range. Results preserve the requested instrument identifiers as keys and can include supported bonds when other identifiers are unavailable. Provider or environment scope determines the contribution returned; omitting both selects the caller’s organisation. The legacy ReturnContributedData flag is accepted, but the provider scope selected for the request determines the source independently. This operation is read-only.

POST

api

MarketData

GetBondData

Retrieve bond price observations.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/MarketData/GetBondData \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetBondDataRequest, 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>"
    }
  ],
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "return_contributed_data": true
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/MarketData/GetBondData"

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiGetBondDataRequest, 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>"
        }
    ],
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "return_contributed_data": True
}
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.ApiGetBondDataRequest, 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>'
      }
    ],
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    return_contributed_data: true
  })
};

fetch('https://api.riskportal.activeviam.com/api/MarketData/GetBondData', 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/GetBondData",
  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.ApiGetBondDataRequest, 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>'
        ]
    ],
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'return_contributed_data' => true
  ]),
  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/GetBondData"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetBondDataRequest, 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  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"return_contributed_data\": true\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/GetBondData")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetBondDataRequest, 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  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"return_contributed_data\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/MarketData/GetBondData")

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.ApiGetBondDataRequest, 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  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"return_contributed_data\": true\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetBondDataResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "bond_data": [
    {
      "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.BondData, 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,
          "bond_id": "<string>",
          "close": 123,
          "currency": "<string>",
          "date": "2023-11-07T05:31:56Z",
          "high": 123,
          "low": 123,
          "open": 123,
          "contributor": "<string>",
          "volume": 123,
          "liquidity_score": 123,
          "is_live_price": true
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

The query payload. Identifiers must be non-empty supported bond identifiers, StartDate and EndDate are date-only inclusive boundaries, and provider or environment fields select one authorised source.

Queries dated bond trading observations by bond selector and date range.

$type

enum<string>

required

Available options:

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

identifiers

object[] | null

Instrument selectors whose bond observations are requested.

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

Option 1
Option 2

Show child attributes

start_date

string<date-time>

Inclusive lower date-only boundary for the requested observations.

end_date

string<date-time>

Inclusive upper date-only boundary for the requested observations.

return_contributed_data

boolean

Legacy compatibility flag; the resolved provider scope determines the public operation's source, so this value currently has no observable effect.

Response

Returns available bond observations keyed by input identifier and errors for unknown bonds or missing data.

Returns dated bond trading observations and query errors.

$type

enum<string>

required

Available options:

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

bond_data

object[] | null

Bond trading observations returned by the query.

Show child attributes

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve bond price observations.

Authorizations

Body

Response