Clarus API Reference

Dates IrdSpotDate

Compute the spot date (or effective date) given a trade date and a currency. This function accepts a single dates, a collection of date separated by commas, or simply a 4digit year for all calendar dates in a year.

Parameter	Description	Default	Options
currency Optional	Currency	USD	AED , ARS , AUD , BRL , CAD , CHF , CLP , CNH , CNY , COP , CZK , DKK , EGP , EUR , GBP , GHS , HKD , HUF , IDR , ILS , INR , JPY , KRW , KZT , LBP , LKR , MXN , MYR , NGN , NOK , NZD , PEN , PHP , PKR , PLN , RUB , SAR , SEK , SGD , THB , TWD , USD , VEB , VNG , ZAR
tradeDate Optional	The trade date in YYYY-MM-DD format.		For functions that can accept a set of dates, seperate the dates by a comma. Alternatively just enter the year as a 4digit number to define all non-weekend calendar dates in a year.

import clarus

response = clarus.dates.irdspotdate(currency='USD',tradeDate='2017-08-22')
print (response)


Submit to generate...

import com.clarusft.api.model.dates.IrdSpotDateRequest
import com.clarusft.api.model.dates.IrdSpotDateResponse

ApiClient clarus = ApiClient.getDefault();
IrdSpotDateResponse response = clarus.request(new IrdSpotDateRequest().withCurrency("USD").withTradeDate("2017-08-22"));
System.out.println(response);


Submit to generate...

import Clarus

response = Clarus.Dates.irdspotdate(currency="USD",tradeDate="2017-08-22")
print(response)


Submit to generate...


##
##Need to install packages once, if not already installed
##install.packages('httr')
##install.packages('readr')
##

library('httr')
##library('readr')

## Manually edit and set key/secret here ##
apiKey <- '...'
apiSecret <-'...'

request <- function(category, functionName, ...){
  restUrl  =  paste0('https://apieval.clarusft.com/api/rest/v1/', category, '/',functionName, '.csv')
  response <- POST(url=restUrl, body=list(...), encode='json', authenticate(apiKey, apiSecret, type='basic'))
  if (response$status_code!=200){
      stop(paste0('Request to ', category, '/', functionName, ' failed with status code: ', response$status_code))
  }
  return (response)
}

dataframe <- function(response){
  return (read.csv(text=content(response, 'text'), sep=',', head=TRUE))
}
## filename <- file.path('C:', 'Temp', 'myfile.csv')
## myvalue <- <- read_file(filename)

r <- request('dates', 'IrdSpotDate', currency='USD', tradeDate='2017-08-22')
df <- dataframe(r)
print (df)


import requests
import sys
import pandas
import io
#import os

# Example of REST API call to Clarus Microservices #

# Manually edit and set key/secret here #
apiKey = ''
apiSecret = ''

print (sys.version)

def request(category, functionName, **params):
  restUrl = 'https://apieval.clarusft.com/api/rest/v1/' + category + '/' + functionName + '.json'
  r = requests.post(restUrl, json=params, auth=(apiKey, apiSecret))
  r.raise_for_status()
  return r.json()

def dataframe(results):
  return pandas.DataFrame(results['results'])

# filename = os.path.join('C:\\', 'Temp', 'myfile.csv')
# myvalue = open(filename).read()

r = request('dates', 'IrdSpotDate', currency='USD', tradeDate='2017-08-22')
df = dataframe(r)
print(pandas.DataFrame.head(df))


use strict;
use warnings;
use MIME::Base64;
use JSON;
use REST::Client;

# Example of REST API call to Clarus Microservices #

my $client = REST::Client->new();
$client->addHeader('Content-Type', 'application/json');

# Manually edit and set key/secret here 
my $apiKey = '';
my $apiSecret = '';

my $encoded_auth = encode_base64("$apiKey:$apiSecret", '');
$client->addHeader('Authorization', "Basic $encoded_auth");

my %params = ('currency' => 'USD','tradeDate' => '2017-08-22');

my $urlBase = 'https://apieval.clarusft.com/api/rest/v1/';
my $category = 'dates/';
my $name = 'IrdSpotDate';
my $outputFormat = '.csv'; #can also be '.json' or '.tsv'
my $fullRESTUrl  =  $urlBase . $category . $name . $outputFormat;

$client->POST($fullRESTUrl,encode_json(\%params));

print 'Response: ' . $client->responseContent() . "\n";
print 'Response status: ' . $client->responseCode() . "\n";



printf('Example of REST API call to Clarus Microservices\n');

function r = request(category, functionName, params)

# Manually edit and set key/secret here #
  apiKey = ''
  apiSecret = ''

  restUrl = ['https://' apiKey ":" apiSecret  "@" 'apieval.clarusft.com/api/rest/v1/' category '/' functionName '.csv'];
  [r, status, message] = urlread (restUrl, 'get', params);
  if (status!=1)
      error(['Failed on ' category '/' functionName ': ' message]);
  endif
end

function ca = toCellArray(csvStr)
  header_row = textscan (csvStr, "%s", 1, 'delimiter','\n');
  headers = strsplit(char(header_row), ",");
  numCols = size(headers)(2);
  format = repmat('%s ', [1 numCols]);
  ca = textscan (csvStr, format, 'delimiter',',', 'endofline',"\n");
end

params = {'currency', 'USD', ...
          'tradeDate', '2017-08-22'}

r = request('dates', 'IrdSpotDate', params)
ca = toCellArray(r);

ca



Example of REST API query URL (GET)

CSV
https://apieval.clarusft.com/api/rest/v1/dates/irdspotdate.csv?currency=USD&tradeDate=2017-08-22

TSV
https://apieval.clarusft.com/api/rest/v1/dates/irdspotdate.tsv?currency=USD&tradeDate=2017-08-22

JSON
https://apieval.clarusft.com/api/rest/v1/dates/irdspotdate.json?currency=USD&tradeDate=2017-08-22

HTML
https://apieval.clarusft.com/api/rest/v1/dates/irdspotdate.html?currency=USD&tradeDate=2017-08-22

Request Body


Submit to generate...

Response


Submit to generate...


{
  "currency" : "USD",
  "tradeDate" : "2017-08-22"
}