Use the Supported Forwards endpoint to get a list of valid currency pairs and their associated tenors for use in the Forward rates endpoint. The result is returned as a list of base currency, quote currency and tenor combinations.
GET /v2/supported_forwards.:output_format[?parameter=value&…]
The :output_format
URL part determines how information is returned. It can
be one of the following values:
json
– Javascript Object Notation
xml
– Well-formed XML documentcsv
– Comma Separated Values
LF
character (hex: 0x0A
;
dec: 10
)The base
parameter is optional and can be specified multiple times to filter the supported list of forward rates
based on base currency.
The quote
parameter is optional and can be specified multiple times to filter the supported list of forward rates
based on quote currency.
The endpoint defaults to returning the entire list of supported currency pairs and tenors.
NOTE: All examples omit authentication, though they do require it.
Request:
GET /v2/supported_forwards.json?base=EUR"e=USD
Response headers & body:
HTTP/1.1 200 OK
Content-Type: application/json
{
"supported_forwards": [
{
"base_currency": "EUR",
"quote_currency": "USD",
"tenor": "ON"
},
{
"base_currency": "EUR",
"quote_currency": "USD",
"tenor": "TN"
},
...
]
}
Request:
GET /v2/supported_forwards.xml?base=EUR"e=USD
Response headers & body:
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
<response>
<supported_forwards>
<supported_forward>
<base_currency>EUR</base_currency>
<quote_currency>USD</quote_currency>
<tenor>ON</tenor>
</supported_forward>
<supported_forward>
<base_currency>EUR</base_currency>
<quote_currency>USD</quote_currency>
<tenor>TN</tenor>
</supported_forward>
...
</currencies>
</response>
Request:
GET /v2/supported_forwards.csv?base=EUR"e=USD
Response headers & body:
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
base_currency,quote_currency,tenor
EUR,USD,ON
EUR,USD,TN
EUR,USD,SN
...
supported_forwards
– (JSON | XML) The container for all supported forward rates combinations
supported_forward
– (XML) The container for each supported forward rates combination
base_currency
– (ALL) The base currency code
quote_currency
– (ALL) The quote currency code
tenor
– (ALL) The tenor code