Retrieve equity reference and market details.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Equity/GetEquityInfo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest, Derivitec.Web.Core",
  "identifier": {
    "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
    "code": "<string>",
    "market_identification_code": "<string>"
  },
  "market_date": "2023-11-07T05:31:56Z",
  "provider_id": "<string>",
  "market_data_environment_names": [
    "<string>"
  ],
  "market_data_environment_name": "Example market data"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/Equity/GetEquityInfo"

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest, Derivitec.Web.Core",
    "identifier": {
        "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
        "code": "<string>",
        "market_identification_code": "<string>"
    },
    "market_date": "2023-11-07T05:31:56Z",
    "provider_id": "<string>",
    "market_data_environment_names": ["<string>"],
    "market_data_environment_name": "Example market data"
}
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.ApiEquityGetInfoRequest, Derivitec.Web.Core',
    identifier: {
      $type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
      code: '<string>',
      market_identification_code: '<string>'
    },
    market_date: '2023-11-07T05:31:56Z',
    provider_id: '<string>',
    market_data_environment_names: ['<string>'],
    market_data_environment_name: 'Example market data'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Equity/GetEquityInfo', 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/Equity/GetEquityInfo",
  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.ApiEquityGetInfoRequest, Derivitec.Web.Core',
    'identifier' => [
        '$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
        'code' => '<string>',
        'market_identification_code' => '<string>'
    ],
    'market_date' => '2023-11-07T05:31:56Z',
    'provider_id' => '<string>',
    'market_data_environment_names' => [
        '<string>'
    ],
    'market_data_environment_name' => 'Example market data'
  ]),
  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/Equity/GetEquityInfo"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\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/Equity/GetEquityInfo")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/Equity/GetEquityInfo")

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.ApiEquityGetInfoRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiEquityGetInfoResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "provider_id": "<string>",
  "cik": "<string>",
  "country": "<string>",
  "currency": "<string>",
  "bbg_code": "<string>",
  "cusip": "<string>",
  "identifier": "<string>",
  "isin": "<string>",
  "name": "<string>",
  "ric": "<string>",
  "sector": "<string>",
  "industry": "<string>",
  "shares_outstanding": "<string>",
  "market_cap": "<string>",
  "free_float_shares": "<string>",
  "share_capital": "<string>",
  "spot": 123,
  "stock_lag": 123,
  "trading_calendar": "<string>",
  "treasury_shares": "<string>",
  "market_data_date": "2023-11-07T05:31:56Z"
}

Retrieve equity reference and market details.

Use this operation for identifiers, name, country, currency, sector/industry, trading calendar, settlement lag, spot, market capitalisation, and share figures for one equity and market date. Missing textual values are represented as N/A; a missing spot is represented as zero. Provider/environment selection applies to market-sensitive fields. The operation is read-only and completes before returning.

POST

api

Equity

GetEquityInfo

Retrieve equity reference and market details.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Equity/GetEquityInfo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest, Derivitec.Web.Core",
  "identifier": {
    "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
    "code": "<string>",
    "market_identification_code": "<string>"
  },
  "market_date": "2023-11-07T05:31:56Z",
  "provider_id": "<string>",
  "market_data_environment_names": [
    "<string>"
  ],
  "market_data_environment_name": "Example market data"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/Equity/GetEquityInfo"

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest, Derivitec.Web.Core",
    "identifier": {
        "$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
        "code": "<string>",
        "market_identification_code": "<string>"
    },
    "market_date": "2023-11-07T05:31:56Z",
    "provider_id": "<string>",
    "market_data_environment_names": ["<string>"],
    "market_data_environment_name": "Example market data"
}
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.ApiEquityGetInfoRequest, Derivitec.Web.Core',
    identifier: {
      $type: 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
      code: '<string>',
      market_identification_code: '<string>'
    },
    market_date: '2023-11-07T05:31:56Z',
    provider_id: '<string>',
    market_data_environment_names: ['<string>'],
    market_data_environment_name: 'Example market data'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Equity/GetEquityInfo', 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/Equity/GetEquityInfo",
  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.ApiEquityGetInfoRequest, Derivitec.Web.Core',
    'identifier' => [
        '$type' => 'Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core',
        'code' => '<string>',
        'market_identification_code' => '<string>'
    ],
    'market_date' => '2023-11-07T05:31:56Z',
    'provider_id' => '<string>',
    'market_data_environment_names' => [
        '<string>'
    ],
    'market_data_environment_name' => 'Example market data'
  ]),
  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/Equity/GetEquityInfo"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\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/Equity/GetEquityInfo")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/Equity/GetEquityInfo")

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.ApiEquityGetInfoRequest, Derivitec.Web.Core\",\n  \"identifier\": {\n    \"$type\": \"Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core\",\n    \"code\": \"<string>\",\n    \"market_identification_code\": \"<string>\"\n  },\n  \"market_date\": \"2023-11-07T05:31:56Z\",\n  \"provider_id\": \"<string>\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"market_data_environment_name\": \"Example market data\"\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiEquityGetInfoResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "provider_id": "<string>",
  "cik": "<string>",
  "country": "<string>",
  "currency": "<string>",
  "bbg_code": "<string>",
  "cusip": "<string>",
  "identifier": "<string>",
  "isin": "<string>",
  "name": "<string>",
  "ric": "<string>",
  "sector": "<string>",
  "industry": "<string>",
  "shares_outstanding": "<string>",
  "market_cap": "<string>",
  "free_float_shares": "<string>",
  "share_capital": "<string>",
  "spot": 123,
  "stock_lag": 123,
  "trading_calendar": "<string>",
  "treasury_shares": "<string>",
  "market_data_date": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Body

A supported equity Identifier, date-only MarketDate, and one authorised provider-selector form.

Selects an equity and market-data date for descriptive, quote, share-count, and settlement details.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.MarketData.ApiEquityGetInfoRequest, Derivitec.Web.Core

identifier

object

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

Option 1
Option 2

Show child attributes

market_date

string<date-time>

Market date used by the derived request.

provider_id

string | null

Opaque identifier of a single market-data provider to use instead of either environment-name option.

entity_access_type

enum<string>

Access classification associated with the selected market-data environment.

Available options:

view,

edit,

owner,

blocked

market_data_environment_names

string[] | null

Names of the market-data environments to use. Do not combine this list with the single-name or provider-ID alternatives.

market_data_environment_name

string | null

Single market-data environment name to use instead of market_data_environment_names or provider_id.

Example:

"Example market data"

Response

Returns available equity reference and market details, including the N/A/zero placeholder model when reference data is unavailable.

Returns descriptive and market details for the selected equity.

$type

enum<string>

required

Available options:

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

cik

string | null

Central Index Key, or the literal N/A when none is available.

country

string | null

Country of origin, or the literal N/A when none is available.

currency

string | null

Recorded trading currency code, or the literal N/A when none is available.

bbg_code

string | null

Bloomberg code, or the literal N/A when none is available.

cusip

string | null

CUSIP code, or the literal N/A when none is available.

identifier

string | null

Equity identifier resolved from the request.

isin

string | null

ISIN code, or the literal N/A when none is available.

name

string | null

Equity name, or the literal N/A when none is available.

ric

string | null

Reuters Instrument Code from the equity details; unlike the other text fields, a missing value is not replaced with N/A.

sector

string | null

Sector classification, or the literal N/A when none is available.

industry

string | null

Industry classification, or the literal N/A when none is available.

shares_outstanding

string | null

Display text for the latest available outstanding-share count, using B/M abbreviations or grouped whole numbers; N/A when unavailable.

market_cap

string | null

Market-capitalisation display text with a currency prefix and B/M abbreviation where applicable; N/A when unavailable.

free_float_shares

string | null

Display text for the latest available free-float share count, using B/M abbreviations or grouped whole numbers; N/A when unavailable.

Share-capital display text, currently the literal N/A.

spot

number<double>

Latest available spot quote on or before the market-data date; zero is returned when unavailable.

stock_lag

integer<int64>

Settlement lag returned when equity details are found; otherwise zero. The public contract does not establish its unit.

trading_calendar

string | null

Calendar identifier for display and holiday lookup, taken from the saved equity for the requested date and providers. If unavailable, uses the current StockInfo.HolidayCalendarId for either stocks or indices when non-empty, otherwise the index exchange or stock market identification code. N/A when no identifier is available.

treasury_shares

string | null

Treasury-share display text using B/M abbreviations, grouped whole numbers, or N/A.

market_data_date

string<date-time>

Market-data date copied from the request when equity details are found; otherwise the response retains the default date value.

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve equity reference and market details.

Authorizations

Body

Response