Retrieve contracts for a client trade reference.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Position/GetContractsFromClientTradableId \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core",
  "market_data_environment_name": "Example market data",
  "provider_id": "<string>",
  "portfolio_name": "<string>",
  "client_tradable_id": "<string>",
  "as_of_date_time": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/Position/GetContractsFromClientTradableId"

payload = {
    "$type": "Derivitec.Web.Core.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core",
    "market_data_environment_name": "Example market data",
    "provider_id": "<string>",
    "portfolio_name": "<string>",
    "client_tradable_id": "<string>",
    "as_of_date_time": "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.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core',
    market_data_environment_name: 'Example market data',
    provider_id: '<string>',
    portfolio_name: '<string>',
    client_tradable_id: '<string>',
    as_of_date_time: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Position/GetContractsFromClientTradableId', 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/Position/GetContractsFromClientTradableId",
  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.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core',
    'market_data_environment_name' => 'Example market data',
    'provider_id' => '<string>',
    'portfolio_name' => '<string>',
    'client_tradable_id' => '<string>',
    'as_of_date_time' => '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/Position/GetContractsFromClientTradableId"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"portfolio_name\": \"<string>\",\n  \"client_tradable_id\": \"<string>\",\n  \"as_of_date_time\": \"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/Position/GetContractsFromClientTradableId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"portfolio_name\": \"<string>\",\n  \"client_tradable_id\": \"<string>\",\n  \"as_of_date_time\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/Position/GetContractsFromClientTradableId")

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.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"portfolio_name\": \"<string>\",\n  \"client_tradable_id\": \"<string>\",\n  \"as_of_date_time\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "$type": "Derivitec.Web.Core.Tradables.ApiGetContractsFromTradableIdsResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "contracts": [
    {
      "$type": "Derivitec.Web.Core.Tradables.TradableData, Derivitec.Web.Core",
      "tradable_id": "<string>",
      "contract": {
        "$type": "Derivitec.Web.Core.Tradables.Ascot, Derivitec.Web.Core",
        "identifier": "<string>",
        "currency": "<string>",
        "expiration_date": "2023-11-07T05:31:56Z",
        "asset_swap_spread": 123,
        "bond_identifier": {
          "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
          "code": "<string>",
          "identifier_type": "Derivitec",
          "market_identification_code": "<string>"
        },
        "business_day_convention": "actual",
        "calendar_name": "<string>",
        "coupon_rate": 123,
        "day_count_convention": "actual_actual_icma",
        "end_stub": "none",
        "end_to_end": true,
        "notional": 123,
        "payment_lag": 123,
        "period_str": "<string>",
        "rate_asset_name": "<string>",
        "roll_date": "2023-11-07T05:31:56Z",
        "start_date": "2023-11-07T05:31:56Z",
        "start_stub": "none",
        "initial_fx_rate": 123
      },
      "as_of_date": "2023-11-07T05:31:56Z",
      "display_name": "<string>"
    }
  ]
}

Retrieve contracts for a client trade reference.

Returns the contract definitions associated with a client trade reference in a portfolio available to the caller. This is read-only.

When AsOfDateTime is its default value, the caller’s current calendar date is used; otherwise the supplied date is evaluated at end of day in the caller’s time zone. An unavailable portfolio or unmatched reference is reported in the response payload.

POST

api

Position

GetContractsFromClientTradableId

Retrieve contracts for a client trade reference.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Position/GetContractsFromClientTradableId \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core",
  "market_data_environment_name": "Example market data",
  "provider_id": "<string>",
  "portfolio_name": "<string>",
  "client_tradable_id": "<string>",
  "as_of_date_time": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/Position/GetContractsFromClientTradableId"

payload = {
    "$type": "Derivitec.Web.Core.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core",
    "market_data_environment_name": "Example market data",
    "provider_id": "<string>",
    "portfolio_name": "<string>",
    "client_tradable_id": "<string>",
    "as_of_date_time": "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.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core',
    market_data_environment_name: 'Example market data',
    provider_id: '<string>',
    portfolio_name: '<string>',
    client_tradable_id: '<string>',
    as_of_date_time: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Position/GetContractsFromClientTradableId', 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/Position/GetContractsFromClientTradableId",
  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.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core',
    'market_data_environment_name' => 'Example market data',
    'provider_id' => '<string>',
    'portfolio_name' => '<string>',
    'client_tradable_id' => '<string>',
    'as_of_date_time' => '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/Position/GetContractsFromClientTradableId"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"portfolio_name\": \"<string>\",\n  \"client_tradable_id\": \"<string>\",\n  \"as_of_date_time\": \"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/Position/GetContractsFromClientTradableId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"portfolio_name\": \"<string>\",\n  \"client_tradable_id\": \"<string>\",\n  \"as_of_date_time\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/Position/GetContractsFromClientTradableId")

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.Positions.ApiGetContractsFromClientTradableIdRequest, Derivitec.Web.Core\",\n  \"market_data_environment_name\": \"Example market data\",\n  \"provider_id\": \"<string>\",\n  \"portfolio_name\": \"<string>\",\n  \"client_tradable_id\": \"<string>\",\n  \"as_of_date_time\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "$type": "Derivitec.Web.Core.Tradables.ApiGetContractsFromTradableIdsResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "contracts": [
    {
      "$type": "Derivitec.Web.Core.Tradables.TradableData, Derivitec.Web.Core",
      "tradable_id": "<string>",
      "contract": {
        "$type": "Derivitec.Web.Core.Tradables.Ascot, Derivitec.Web.Core",
        "identifier": "<string>",
        "currency": "<string>",
        "expiration_date": "2023-11-07T05:31:56Z",
        "asset_swap_spread": 123,
        "bond_identifier": {
          "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
          "code": "<string>",
          "identifier_type": "Derivitec",
          "market_identification_code": "<string>"
        },
        "business_day_convention": "actual",
        "calendar_name": "<string>",
        "coupon_rate": 123,
        "day_count_convention": "actual_actual_icma",
        "end_stub": "none",
        "end_to_end": true,
        "notional": 123,
        "payment_lag": 123,
        "period_str": "<string>",
        "rate_asset_name": "<string>",
        "roll_date": "2023-11-07T05:31:56Z",
        "start_date": "2023-11-07T05:31:56Z",
        "start_stub": "none",
        "initial_fx_rate": 123
      },
      "as_of_date": "2023-11-07T05:31:56Z",
      "display_name": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

JSON request with a non-empty PortfolioName, optional PortfolioType when the name is unambiguous, non-empty ClientTradableId, optional AsOfDateTime, and one accessible market-data environment selected by name or identifier.

Portfolio, client tradable reference, date, and market-data selection used to retrieve matching contract definitions.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.Positions.ApiGetContractsFromClientTradableIdRequest, 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.

portfolio_name

string | null

Name of the accessible portfolio in which the client reference is resolved.

client_tradable_id

string | null

Client-supplied tradable reference to match within the selected portfolio.

portfolio_type

enum<string> | null

Portfolio source used to disambiguate the supplied portfolio name.

Available options:

derivitec,

enfusion,

orchestrade,

liquidity_book,

maia,

fund_studio,

not_set

as_of_date_time

string<date-time>

Calendar date used to select portfolio holdings; the default value uses the server's current date.

Response

Returns matching contracts, or IsSuccess = false with errors when the portfolio, client reference, or contract cannot be used.

Contracts matched to requested tradable identifiers.

$type

enum<string>

required

Available options:

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

contracts

object[] | null

Resolved contracts with their tradable identifiers and display context.

Show child attributes

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve contracts for a client trade reference.

Authorizations

Body

Response