Retrieve portfolio transactions for a date range.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Position/GetTransactionTable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core",
  "portfolio_name": "Example portfolio",
  "counterparties": [
    "<string>"
  ],
  "end_date": "2023-11-07T05:31:56Z",
  "include_zero_quantities": true,
  "start_date": "2023-11-07T05:31:56Z"
}
'

import requests

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

payload = {
    "$type": "Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core",
    "portfolio_name": "Example portfolio",
    "counterparties": ["<string>"],
    "end_date": "2023-11-07T05:31:56Z",
    "include_zero_quantities": True,
    "start_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.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core',
    portfolio_name: 'Example portfolio',
    counterparties: ['<string>'],
    end_date: '2023-11-07T05:31:56Z',
    include_zero_quantities: true,
    start_date: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Position/GetTransactionTable', 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/GetTransactionTable",
  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.ApiGetTransactionTableRequest, Derivitec.Web.Core',
    'portfolio_name' => 'Example portfolio',
    'counterparties' => [
        '<string>'
    ],
    'end_date' => '2023-11-07T05:31:56Z',
    'include_zero_quantities' => true,
    'start_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/Position/GetTransactionTable"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core\",\n  \"portfolio_name\": \"Example portfolio\",\n  \"counterparties\": [\n    \"<string>\"\n  ],\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"include_zero_quantities\": true,\n  \"start_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/Position/GetTransactionTable")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core\",\n  \"portfolio_name\": \"Example portfolio\",\n  \"counterparties\": [\n    \"<string>\"\n  ],\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"include_zero_quantities\": true,\n  \"start_date\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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.ApiGetTransactionTableRequest, Derivitec.Web.Core\",\n  \"portfolio_name\": \"Example portfolio\",\n  \"counterparties\": [\n    \"<string>\"\n  ],\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"include_zero_quantities\": true,\n  \"start_date\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "$type": "Derivitec.Web.Core.Positions.ApiGetTransactionTableResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "data_table": [
    {}
  ]
}

POST

api

Position

GetTransactionTable

Retrieve portfolio transactions for a date range.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Position/GetTransactionTable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core",
  "portfolio_name": "Example portfolio",
  "counterparties": [
    "<string>"
  ],
  "end_date": "2023-11-07T05:31:56Z",
  "include_zero_quantities": true,
  "start_date": "2023-11-07T05:31:56Z"
}
'

import requests

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

payload = {
    "$type": "Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core",
    "portfolio_name": "Example portfolio",
    "counterparties": ["<string>"],
    "end_date": "2023-11-07T05:31:56Z",
    "include_zero_quantities": True,
    "start_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.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core',
    portfolio_name: 'Example portfolio',
    counterparties: ['<string>'],
    end_date: '2023-11-07T05:31:56Z',
    include_zero_quantities: true,
    start_date: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Position/GetTransactionTable', 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/GetTransactionTable",
  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.ApiGetTransactionTableRequest, Derivitec.Web.Core',
    'portfolio_name' => 'Example portfolio',
    'counterparties' => [
        '<string>'
    ],
    'end_date' => '2023-11-07T05:31:56Z',
    'include_zero_quantities' => true,
    'start_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/Position/GetTransactionTable"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core\",\n  \"portfolio_name\": \"Example portfolio\",\n  \"counterparties\": [\n    \"<string>\"\n  ],\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"include_zero_quantities\": true,\n  \"start_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/Position/GetTransactionTable")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core\",\n  \"portfolio_name\": \"Example portfolio\",\n  \"counterparties\": [\n    \"<string>\"\n  ],\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"include_zero_quantities\": true,\n  \"start_date\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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.ApiGetTransactionTableRequest, Derivitec.Web.Core\",\n  \"portfolio_name\": \"Example portfolio\",\n  \"counterparties\": [\n    \"<string>\"\n  ],\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"include_zero_quantities\": true,\n  \"start_date\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "$type": "Derivitec.Web.Core.Positions.ApiGetTransactionTableResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "data_table": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

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

Body

JSON request with non-empty PortfolioName, optional unambiguous PortfolioType, StartDate, EndDate, optional Counterparties, and IncludeZeroQuantities. A default start date has no effective lower bound; provide an end date for a meaningful result. Date ordering is not explicitly constrained.

Portfolio, date window, counterparty filter, and zero-quantity choice used to retrieve a transaction table.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.Positions.ApiGetTransactionTableRequest, Derivitec.Web.Core

portfolio_name

string | null

Name of the portfolio to select. The value must not be null or empty.

Example:

"Example portfolio"

portfolio_type

enum<string> | null

Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.

Available options:

derivitec,

enfusion,

orchestrade,

liquidity_book,

maia,

fund_studio,

not_set

counterparties

string[] | null

Optional counterparty names that restrict the returned rows.

end_date

string<date-time>

Inclusive final calendar date, evaluated at end of day in the caller's time zone.

include_zero_quantities

boolean

Whether to retain positions whose quantities net to zero; defaults to false.

start_date

string<date-time>

Initial calendar date; its default value applies no effective lower date bound.

Response

Returns the transaction data table, or an unsuccessful payload when the portfolio is unavailable to the caller.

Option 1
Option 2

Tabular portfolio positions or transactions produced by a position-table query.

$type

enum<string>

required

Available options:

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

data_table

object[] | null

JSON row table using the caller's organisation-specific columns and grouping when configured.

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve portfolio transactions for a date range.

Authorizations

Body

Response