Retrieve FX price history.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Fx/GetFxHistory \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiFxGetHistoryRequest, Derivitec.Web.Core",
  "fx_pair": "<string>",
  "market_date": "2023-11-07T05:31:56Z",
  "provider_id": "<string>",
  "market_data_environment_names": [
    "<string>"
  ],
  "market_data_environment_name": "Example market data",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "fx_cut": "<string>",
  "include_hi_low": false
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/Fx/GetFxHistory"

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiFxGetHistoryRequest, Derivitec.Web.Core",
    "fx_pair": "<string>",
    "market_date": "2023-11-07T05:31:56Z",
    "provider_id": "<string>",
    "market_data_environment_names": ["<string>"],
    "market_data_environment_name": "Example market data",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "fx_cut": "<string>",
    "include_hi_low": False
}
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.ApiFxGetHistoryRequest, Derivitec.Web.Core',
    fx_pair: '<string>',
    market_date: '2023-11-07T05:31:56Z',
    provider_id: '<string>',
    market_data_environment_names: ['<string>'],
    market_data_environment_name: 'Example market data',
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    fx_cut: '<string>',
    include_hi_low: false
  })
};

fetch('https://api.riskportal.activeviam.com/api/Fx/GetFxHistory', 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/Fx/GetFxHistory",
  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.ApiFxGetHistoryRequest, Derivitec.Web.Core',
    'fx_pair' => '<string>',
    'market_date' => '2023-11-07T05:31:56Z',
    'provider_id' => '<string>',
    'market_data_environment_names' => [
        '<string>'
    ],
    'market_data_environment_name' => 'Example market data',
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'fx_cut' => '<string>',
    'include_hi_low' => false
  ]),
  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/Fx/GetFxHistory"

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

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/Fx/GetFxHistory")

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.ApiFxGetHistoryRequest, Derivitec.Web.Core\",\n  \"fx_pair\": \"<string>\",\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  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"fx_cut\": \"<string>\",\n  \"include_hi_low\": false\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiFxGetHistoryResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "fx_data": [
    {
      "$type": "Derivitec.Web.Core.MarketData.FxData, 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,
      "close": 123,
      "open": 123,
      "high": 123,
      "low": 123,
      "date": "2023-11-07T05:31:56Z",
      "fx_pair": "<string>",
      "fixing_type": "<string>"
    }
  ]
}

POST

api

GetFxHistory

Retrieve FX price history.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Fx/GetFxHistory \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiFxGetHistoryRequest, Derivitec.Web.Core",
  "fx_pair": "<string>",
  "market_date": "2023-11-07T05:31:56Z",
  "provider_id": "<string>",
  "market_data_environment_names": [
    "<string>"
  ],
  "market_data_environment_name": "Example market data",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "fx_cut": "<string>",
  "include_hi_low": false
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/Fx/GetFxHistory"

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiFxGetHistoryRequest, Derivitec.Web.Core",
    "fx_pair": "<string>",
    "market_date": "2023-11-07T05:31:56Z",
    "provider_id": "<string>",
    "market_data_environment_names": ["<string>"],
    "market_data_environment_name": "Example market data",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "fx_cut": "<string>",
    "include_hi_low": False
}
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.ApiFxGetHistoryRequest, Derivitec.Web.Core',
    fx_pair: '<string>',
    market_date: '2023-11-07T05:31:56Z',
    provider_id: '<string>',
    market_data_environment_names: ['<string>'],
    market_data_environment_name: 'Example market data',
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    fx_cut: '<string>',
    include_hi_low: false
  })
};

fetch('https://api.riskportal.activeviam.com/api/Fx/GetFxHistory', 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/Fx/GetFxHistory",
  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.ApiFxGetHistoryRequest, Derivitec.Web.Core',
    'fx_pair' => '<string>',
    'market_date' => '2023-11-07T05:31:56Z',
    'provider_id' => '<string>',
    'market_data_environment_names' => [
        '<string>'
    ],
    'market_data_environment_name' => 'Example market data',
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'fx_cut' => '<string>',
    'include_hi_low' => false
  ]),
  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/Fx/GetFxHistory"

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

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/Fx/GetFxHistory")

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.ApiFxGetHistoryRequest, Derivitec.Web.Core\",\n  \"fx_pair\": \"<string>\",\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  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"fx_cut\": \"<string>\",\n  \"include_hi_low\": false\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiFxGetHistoryResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "fx_data": [
    {
      "$type": "Derivitec.Web.Core.MarketData.FxData, 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,
      "close": 123,
      "open": 123,
      "high": 123,
      "low": 123,
      "date": "2023-11-07T05:31:56Z",
      "fx_pair": "<string>",
      "fixing_type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

A slash-delimited FxPair, date-only StartDate/EndDate, optional FxCut for meaningful high/low retrieval, optional IncludeHiLow (default false), and one authorised provider-selector form.

Selects an FX pair and date range for open and close history, with optional cut-specific high and low observations.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.MarketData.ApiFxGetHistoryRequest, Derivitec.Web.Core

fx_pair

string | null

FX pair selected by derived requests.

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"

start_date

string<date-time>

First date supplied to the FX history lookup.

end_date

string<date-time>

Last date supplied to the FX history lookup.

fx_cut

string | null

Fixing-cut code used for the optional high-and-low lookup and copied to each returned observation.

include_hi_low

boolean

Whether to request cut-specific high and low values in addition to open and close values.

Example:

false

Response

Returns available dated open/close and optional high/low observations, with missing-series or high/low errors in the response payload.

Returns available FX open and close observations with optional cut-specific high and low values.

$type

enum<string>

required

Available options:

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

fx_data

object[] | null

Dated open and close observations, with high and low values when requested and available.

Show child attributes

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve FX price history.

Authorizations

Body

Response