List available FX pairs.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Fx/GetFxPairs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsRequest, Derivitec.Web.Core",
  "is_paginated_request": "<string>",
  "start_row": 123,
  "end_row": 123,
  "search_term": "<string>"
}
'

import requests

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

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsRequest, Derivitec.Web.Core",
    "is_paginated_request": "<string>",
    "start_row": 123,
    "end_row": 123,
    "search_term": "<string>"
}
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.ApiGetFxCrossPairsRequest, Derivitec.Web.Core',
    is_paginated_request: '<string>',
    start_row: 123,
    end_row: 123,
    search_term: '<string>'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Fx/GetFxPairs', 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/GetFxPairs",
  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.ApiGetFxCrossPairsRequest, Derivitec.Web.Core',
    'is_paginated_request' => '<string>',
    'start_row' => 123,
    'end_row' => 123,
    'search_term' => '<string>'
  ]),
  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/GetFxPairs"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsRequest, Derivitec.Web.Core\",\n  \"is_paginated_request\": \"<string>\",\n  \"start_row\": 123,\n  \"end_row\": 123,\n  \"search_term\": \"<string>\"\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/GetFxPairs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsRequest, Derivitec.Web.Core\",\n  \"is_paginated_request\": \"<string>\",\n  \"start_row\": 123,\n  \"end_row\": 123,\n  \"search_term\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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.ApiGetFxCrossPairsRequest, Derivitec.Web.Core\",\n  \"is_paginated_request\": \"<string>\",\n  \"start_row\": 123,\n  \"end_row\": 123,\n  \"search_term\": \"<string>\"\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "last_row": true,
  "search_term": "<string>",
  "search_key": "<string>",
  "fx_cross_pairs": [
    {
      "$type": "Derivitec.Web.Core.MarketData.FxPair, Derivitec.Web.Core",
      "code": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ]
}

List available FX pairs.

Use this operation to build an FX-pair picker from all ordered combinations of covered currencies, including covered crypto currencies. Filter text is matched case-insensitively against the displayed pair name. StartRow is zero-based and EndRow is exclusive. Pass the returned slash-delimited Code, rather than Name, to FX detail operations. IsPaginatedRequest does not affect this action. It is read-only and completes before returning.

POST

api

GetFxPairs

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/Fx/GetFxPairs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsRequest, Derivitec.Web.Core",
  "is_paginated_request": "<string>",
  "start_row": 123,
  "end_row": 123,
  "search_term": "<string>"
}
'

import requests

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

payload = {
    "$type": "Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsRequest, Derivitec.Web.Core",
    "is_paginated_request": "<string>",
    "start_row": 123,
    "end_row": 123,
    "search_term": "<string>"
}
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.ApiGetFxCrossPairsRequest, Derivitec.Web.Core',
    is_paginated_request: '<string>',
    start_row: 123,
    end_row: 123,
    search_term: '<string>'
  })
};

fetch('https://api.riskportal.activeviam.com/api/Fx/GetFxPairs', 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/GetFxPairs",
  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.ApiGetFxCrossPairsRequest, Derivitec.Web.Core',
    'is_paginated_request' => '<string>',
    'start_row' => 123,
    'end_row' => 123,
    'search_term' => '<string>'
  ]),
  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/GetFxPairs"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsRequest, Derivitec.Web.Core\",\n  \"is_paginated_request\": \"<string>\",\n  \"start_row\": 123,\n  \"end_row\": 123,\n  \"search_term\": \"<string>\"\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/GetFxPairs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsRequest, Derivitec.Web.Core\",\n  \"is_paginated_request\": \"<string>\",\n  \"start_row\": 123,\n  \"end_row\": 123,\n  \"search_term\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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.ApiGetFxCrossPairsRequest, Derivitec.Web.Core\",\n  \"is_paginated_request\": \"<string>\",\n  \"start_row\": 123,\n  \"end_row\": 123,\n  \"search_term\": \"<string>\"\n}"

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

{
  "$type": "Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "last_row": true,
  "search_term": "<string>",
  "search_key": "<string>",
  "fx_cross_pairs": [
    {
      "$type": "Derivitec.Web.Core.MarketData.FxPair, Derivitec.Web.Core",
      "code": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

A non-null SearchTerm, StartRow greater than or equal to 0, and EndRow greater than StartRow.

Searches and pages ordered FX currency pairs using zero-based row bounds.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.MarketData.ApiGetFxCrossPairsRequest, Derivitec.Web.Core

is_paginated_request

string | null

Compatibility paging-mode field with no observable effect in current MarketData listing operations.

start_row

integer<int32>

Starting row selector for the requested page; indexing conventions are operation-specific.

end_row

integer<int32>

Upper row selector for the requested page; each listing operation defines whether it is inclusive or exclusive.

search_term

string | null

Text used to filter the available instruments.

Response

Returns pair codes, display names, descriptions, the echoed filter text, and a last-page flag.

Returns a page of matching FX pairs and echoes the search text.

$type

enum<string>

required

Available options:

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

last_row

boolean

Whether the returned page is the final page of results.

Example:

true

search_term

string | null

Search text associated with the paginated response, or null when it is not populated.

search_key

string | null

Search text copied from the request.

fx_cross_pairs

object[] | null

Matching ordered FX pairs in the requested row window.

Show child attributes

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

List available FX pairs.

Authorizations

Body

Response