StatPro Revolution Web API


The Risk Free Rates Resource


Overview

The Risk Free Rates resource represents a collection of risk free rates accessible to the logged-in user. Risk Free Rates in the collection can include system owned ones, those that are owned by the user, and those that are owned by other users and currently shared to the identified user.

Requests for the Risk Free Rates resource always contain information regarding how the user's risk free rates are to be filtered, ordered and sliced before being returned in a response. These instructions may be supplied by the client application (when using a link whose link relation is riskfreerates-query), or by the service itself when emitting a non-query link (e.g. a link to the next page of Risk Free Rates).

The underlying collection is first filtered. The filtered set is then ordered. Finally the ordered set is sliced by skipping N risk free rates and taking M risk free rates. If not all of the ordered set is returned in a response, and if N is a multiple of M (e.g. skip 8, take 4), then the risk free rates in the resource representation are paged. A paged collection will include links to the first and last pages, and optionally to the previous and/or next pages.

If no filtering, ordering and slicing information is contained in a request, then defaults are used:- no filtering; ordered by name; take a maximum of 100 risk free rates. Note that the web service imposes a maximum 'take limit' of 100 risk free rates for all requests for the resource: it is not possible to retrieve more than 100 risk free rates in any one response.

For more information on filtering, ordering and slicing, refer to the documentation for the riskfreerates-query link relation.

The resource representation includes details such as the name, unique identifier, code and owner name of each risk free rate.


Media types

The Risk Free Rates resource is exposed via XML and JSON representations, which have the following media type names:-

application/vnd.statpro.revolution.api.riskfreerates+json

application/vnd.statpro.revolution.api.riskfreerates+xml

When a response is received from the web service with status 200 (= OK), the fact that the response contains a Risk Free Rates resource representation is indicated by the presence of one of these two response headers:-

Content-Type: application/vnd.statpro.revolution.api.riskfreerates+json; charset=utf-8

Content-Type: application/vnd.statpro.revolution.api.riskfreerates+xml; charset=utf-8


Related resources

The Risk Free Rates resource links to the Service resource. It also links to itself in a variety of different ways. To do so, its resource representations use link relations:-

  • service
  • self
  • first
  • next
  • prev
  • last
  • riskfreerates-query

The service link relation identifies the Service resource link.

The self link relation identifies the Risk Free Rates resource link, in which the representation is the same as the one that has been currently retrieved (so long as the underlying data on the server hasn't changed).

The first and last link relations are present only if the retrieved collection is paged. They identify the first and last pages in the collection (at the time when the resource representation was generated).

The next and prev link relations are present only if the retrieved collection is paged and there is a next page and/or previous page in the collection (at the time when the resource representation was generated).

The riskfreerates-query link relation identifies the resource link that allows a fresh query for risk free rates to be made. The fact that the link relation ends with "-query" indicates that a client-specified query must be made for risk free rates, when using this link. This is done by replacing all the text-replacement parts of the link's query string (such as {filter}) with values. Specifying invalid values will result in a 400 (= Bad Request) response. All the text replacement parts of the query string can be replaced with the empty string. To apply filtering, ordering and slicing according to a subset of the ODATA system query options syntax, please refer to the riskfreerates-query link relation's documentation page.

All related resources are accessed using the HTTP GET method.


Update history

  • Initial Version - December 2016

Annotated Representation (JSON)

Legend

{
  "riskFreeRates": {
    "links": {
      "service": {
        "rel": "service",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.service+json"
      },
      "self": {
        "rel": "self",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.riskfreerates+json"
      },
      "next": {
        "rel": "next",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.riskfreerates+json"
      },
      "prev": {
        "rel": "prev",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.riskfreerates+json"
      },
      "first": {
        "rel": "first",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.riskfreerates+json"
      },
      "last": {
        "rel": "last",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.riskfreerates+json"
      },
      "riskFreeRatesQuery": {
        "rel": "riskfreerates-query",
        "href": "...?$filter={filter}&$orderby={orderby}&$skip={skip}&$top={top}",
        "type": "application/vnd.statpro.revolution.api.riskfreerates+json"
      }
    },
    "filteredCount": 16,
    "pageNumber": 2,
    "pageCount": 4,
    "items": [
      {
        "name": "Libor + 2%",
        "id": "df5e9afb-7725-40a4-996b-3aa65655675e",
        "code": "LIBOR+2",
        "owner": "Joe Bloggs",
        "description": "This risk free rate represents a base rate of Libor plus two percent.",
        "currency": "JPY",
        "isSystem": false
      },
      {
        "name": "Argentine Peso - Interbank 1M",
        "id": "ae95e6a2-f403-4258-99ec-cf4c7e53fa55",
        "code": "RTIB_ARS_1M_0",
        "owner": "SYSTEM",
        "description": "Argentine Peso - Interbank 1M",
        "currency": "ARS",
        "isSystem": true
      },
      {
        "name": "Australian Dollar - Interbank 15Y",
        "id": "e61f4e42-a6bd-4318-b18c-ba663d8b4fb8",
        "code": "RTIB_AUD_15Y_0",
        "owner": "SYSTEM",
        "description": "Australian Dollar - Interbank 15Y",
        "currency": "AUD",
        "isSystem": true
      },
      {
        "name": "BA - 1 YEAR",
        "id": "8eb9c712-ea4d-48af-8bc9-77e66969ad3e",
        "code": "190473",
        "owner": "SYSTEM",
        "description": "BANKERS ACCEPTANCE RATE - 1 YEAR",
        "currency": "USD",
        "isSystem": true
      }
    ]
  }
}


Annotated Representation (XML)

Legend

<?xml version="1.0" encoding="utf-8"?>
<riskFreeRates xmlns="http://statpro.com/2012/Revolution">
  <link rel="service"
        href="..."
        type="application/vnd.statpro.revolution.api.service+xml" />
  <link rel="self"
        href="..."
        type="application/vnd.statpro.revolution.api.riskfreerates+xml" />
  <link rel="next"
        href="..."
        type="application/vnd.statpro.revolution.api.riskfreerates+xml" />
  <link rel="prev"
        href="..."
        type="application/vnd.statpro.revolution.api.riskfreerates+xml" />
  <link rel="first"
        href="..."
        type="application/vnd.statpro.revolution.api.riskfreerates+xml" />
  <link rel="last"
        href="..."
        type="application/vnd.statpro.revolution.api.riskfreerates+xml" />
  <link rel="riskfreerates-query"
        href="...?$filter={filter}&amp;$orderby={orderby}&amp;$skip={skip}&amp;$top={top}"
        type="application/vnd.statpro.revolution.api.riskfreerates+xml" />
  <filteredCount>16</filteredCount>
  <pageNumber>2</pageNumber>
  <pageCount>4</pageCount>
  <riskFreeRate>
    <name>Libor + 2%</name>
    <id>df5e9afb-7725-40a4-996b-3aa65655675e</id>
    <code>LIBOR+2</code>
    <owner>Joe Bloggs</owner>
    <description>This risk free rate represents a base rate of Libor plus two percent.</description>
    <currency>JPY</currency>
    <isSystem>false</isSystem>
  </riskFreeRate>
  <riskFreeRate>
    <name>Argentine Peso - Interbank 1M</name>
    <id>ae95e6a2-f403-4258-99ec-cf4c7e53fa55</id>
    <code>RTIB_ARS_1M_0</code>
    <owner>SYSTEM</owner>
    <description>Argentine Peso - Interbank 1M</description>
    <currency>ARS</currency>
    <isSystem>true</isSystem>
  </riskFreeRate>
  <riskFreeRate>
    <name>Australian Dollar - Interbank 15Y</name>
    <id>e61f4e42-a6bd-4318-b18c-ba663d8b4fb8</id>
    <code>RTIB_AUD_15Y_0</code>
    <owner>SYSTEM</owner>
    <description>Australian Dollar - Interbank 15Y</description>
    <currency>AUD</currency>
    <isSystem>true</isSystem>
  </riskFreeRate>
  <riskFreeRate>
    <name>BA - 1 YEAR</name>
    <id>8eb9c712-ea4d-48af-8bc9-77e66969ad3e</id>
    <code>190473</code>
    <owner>SYSTEM</owner>
    <description>BANKERS ACCEPTANCE RATE - 1 YEAR</description>
    <currency>USD</currency>
    <isSystem>true</isSystem>
  </riskFreeRate>
</riskFreeRates>


Last updated: December 2016


To Top