StatPro Revolution Web API


The Historical Risk Trends Resource


Overview

The Historical Risk Trends resource represents the historic set of risk trends for a portfolio. It will contain total level results only.

See annotated representations below for further details of the results output by this resource.


Media types

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

application/vnd.statpro.revolution.api.portfolio-historical-risk-trends+json

application/vnd.statpro.revolution.api.portfolio-historical-risk-trends+xml

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

Content-Type: application/vnd.statpro.revolution.api.portfolio-historical-risk-trends+json; charset=utf-8

Content-Type: application/vnd.statpro.revolution.api.portfolio-historical-risk-trends+xml; charset=utf-8


Related resources

The Historical Risk Trends resource always links to the Service and Porfolios resources (and to itself). To access these resources use the link relations:-

  • self
  • service
  • portfolios-query

The self link relation identifies the link to the current Historical Risk Trends resource.

The service link relation identifies the Service resource link.

The portfolios-query link relation identifies the link that allows a new query for portfolios to be made.

Notes

The columns headers returned in the CSV are fixed but we reserve the right to add new columns in future. If new columns are added in future we will preserve the ordinal position of the columns.

The historical trend data available in this resource is calculated when the portfolios are (re-)calculated so the frequency of trend data is as frequent as the calculations. Unlike other analysis result resources this data is collected on the day of the calculation and cannot be historically re-calculated.

On any given 'valuationDate', the results reflect the latest calculation for the portfolio's default analysis. So if a portfolio's default analysis is re-calculated several times on any given day, the results collected are from the latest successful calculation.

On any given 'valuationDate' we only calculate measures according to their applicability (see table below for applicabilities).

When values are not calculated it will be emitted as an empty string in the CSV output.

The following fixed set of measures are available in the emitted results set:

CSV Column Header Description Applicability
ValueAtRiskPercent % Value at Risk All portfolios
PotentialUpsidePercent % Potential Gain All portfolios
ExpectedShortfallPercent % Expected Shortfall All portfolios
ExpectedUpsidePercent % Expected Upside All portfolios
ExpectedVolatilityPercent % Expected Volatility All portfolios
DiversificationGrade Diversification Grade All portfolios
BenchmarkValueAtRiskPercent Benchmark % Value at Risk Platinum portfolios with a benchmark only
PotentialGainBPercent Benchmark % Potential Gain Platinum portfolios with a benchmark only
ExpectedShortfallBPercent Benchmark % Expected Shortfall Platinum portfolios with a benchmark only
ExpectedUpsideBPercent Benchmark % Expected Upside Platinum portfolios with a benchmark only
ExpectedVolBPercent Benchmark % Expected Volatility Platinum portfolios with a benchmark only
ValueAtRiskRelPercent Relative Value at Risk % Platinum portfolios with a benchmark only
PotentialUpsideRelPercent Relative Potential Gain % Platinum portfolios with a benchmark only
ExpectedShortfallRelPercent Relative Expected Shortfall % Platinum portfolios with a benchmark only
ExpectedUpsideRelPercent Relative Expected Upside % Platinum portfolios with a benchmark only
ExpectedTERel Expected Tracking Error Platinum portfolios with a benchmark only


Update history

  • Initial Version - June 2017

Annotated Representation (JSON)

Legend

{
  "historicalRiskTrends": {
    "links": {
      "service": {
        "rel": "service",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.service+json"
      },
      "portfoliosQuery": {
        "rel": "portfolios-query",
        "href": "...?$filter={filter}&$orderby={orderby}&$skip={skip}&$top={top}&includePublishedPortfolios=false&portfolioClassifierCode=",
        "type": "application/vnd.statpro.revolution.api.portfolios+json"
      },
      "self": {
        "rel": "self",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.portfolio-historical-risk-trends+json"
      }
    },
    "riskTrends": {
      "resultsCsv": [
        "ValuationDate,Percentile,Horizon,RiskFactorHistory,Currency,BenchmarkType,BenchmarkName,SettingsChanged,ValueAtRiskPercent,PotentialUpsidePercent,ExpectedShortfallPercent,ExpectedUpsidePercent,ExpectedVolatilityPercent,DiversificationGrade,BenchmarkValueAtRiskPercent,PotentialGainBPercent,ExpectedShortfallBPercent,ExpectedUpsideBPercent,ExpectedVolBPercent,ValueAtRiskRelPercent,PotentialUpsideRelPercent,ExpectedShortfallRelPercent,ExpectedUpsideRelPercent,ExpectedTERel",
        "2017-05-19,0.95,1,730,GBP,Constituent,MSCI/AC WORLD INDEX,False,1.773774711,1.793613404,2.194917102,2.424384813,1.031097212,23.5961628,1.32417667,1.40606153,1.90577459,2.02738547,0.8501594,0.722457349,0.748519838,1.03982627,1.14203763,",
        "2017-01-03,0.95,1,730,USD,Constituent,MSCI/AC WORLD INDEX,False,1.774606518,1.793859211,2.196178718,2.425542803,1.031608252,23.5327663,1.32407784,1.40505385,1.906654,2.027221,0.849449456,0.7271958,0.75268054,1.04744136,1.14966023,"
      ]
    }
  }
}


Annotated Representation (XML)

Legend

<?xml version="1.0" encoding="utf-8"?>
<historicalRiskTrends xmlns="http://statpro.com/2012/Revolution">
  <link rel="service"
        href="..."
        type="application/vnd.statpro.revolution.api.service+xml" />
  <link rel="portfolios-query"
        href="...?$filter={filter}&amp;$orderby={orderby}&amp;$skip={skip}&amp;$top={top}&amp;includePublishedPortfolios=false&amp;portfolioClassifierCode="
        type="application/vnd.statpro.revolution.api.portfolios+xml" />
  <link rel="self"
        href="..."
        type="application/vnd.statpro.revolution.api.portfolio-historical-risk-trends+xml" />
  <riskTrends>
    <resultsCsv>ValuationDate,Percentile,Horizon,RiskFactorHistory,Currency,BenchmarkType,BenchmarkName,SettingsChanged,ValueAtRiskPercent,PotentialUpsidePercent,ExpectedShortfallPercent,ExpectedUpsidePercent,ExpectedVolatilityPercent,DiversificationGrade,BenchmarkValueAtRiskPercent,PotentialGainBPercent,ExpectedShortfallBPercent,ExpectedUpsideBPercent,ExpectedVolBPercent,ValueAtRiskRelPercent,PotentialUpsideRelPercent,ExpectedShortfallRelPercent,ExpectedUpsideRelPercent,ExpectedTERel
2017-05-19,0.95,1,730,GBP,Constituent,MSCI/AC WORLD INDEX,False,1.773774711,1.793613404,2.194917102,2.424384813,1.031097212,23.5961628,1.32417667,1.40606153,1.90577459,2.02738547,0.8501594,0.722457349,0.748519838,1.03982627,1.14203763,
2017-01-03,0.95,1,730,USD,Constituent,MSCI/AC WORLD INDEX,False,1.774606518,1.793859211,2.196178718,2.425542803,1.031608252,23.5327663,1.32407784,1.40505385,1.906654,2.027221,0.849449456,0.7271958,0.75268054,1.04744136,1.14966023,</resultsCsv>
  </riskTrends>
</historicalRiskTrends>


Last updated: June 2017


To Top