Supported Forwards

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&…]

output_format

The :output_format URL part determines how information is returned. It can be one of the following values:

  • json – Javascript Object Notation
    • All real numbers in JSON responses are returned as strings to prevent JSON parsers from damaging the precision of the quotes.
  • xml – Well-formed XML document
  • csv – Comma Separated Values
    • Can be imported into most spreadsheet and financial applications
    • Note that CSV format provides standard Unix-like line endings (Unix, Linux, *BSD, MacOS > 9 among others) via an LF character (hex: 0x0A; dec: 10)
    • Due to the limitations of this format, only quotes will be returned, and metadata will be excluded from the output

Parameters

base

The base parameter is optional and can be specified multiple times to filter the supported list of forward rates based on base currency.

quote

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.

Examples

NOTE: All examples omit authentication, though they do require it.

JSON

Request:

GET /v2/supported_forwards.json?base=EUR&quote=USD

Response headers & body:

1
2
HTTP/1.1 200 OK
Content-Type: application/json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "supported_forwards": [
        {
            "base_currency": "EUR",
            "quote_currency": "USD",
            "tenor": "ON"
        },
        {
            "base_currency": "EUR",
            "quote_currency": "USD",
            "tenor": "TN"
        },
        ...
    ]
}

XML

Request:

GET /v2/supported_forwards.xml?base=EUR&quote=USD

Response headers & body:

1
2
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<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>

CSV

Request:

GET /v2/supported_forwards.csv?base=EUR&quote=USD

Response headers & body:

1
2
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
1
2
3
4
5
base_currency,quote_currency,tenor
EUR,USD,ON
EUR,USD,TN
EUR,USD,SN
...

Response Fields

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