Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Get an RTG Folio

This request returns a specific Ready-to-Go (RTG) folio model to which folios in member’s brokerage accounts can be subscribed.

Request URL

Syntax GET /restapi/rtgs/{prePackagedFolioOid}
Example URL https://testapi.foliofn.com/restapi/rtgs/007

Response Data Fields

Field Description
methodology A detailed description of how this Ready-to-Go folio was formed along with its update frequency.
name Name of the Ready-to-Go folio.
objective The aim of this RTG folio.
performance An array of performance metrics for this RTG folio.
prePackagedFolioOid The unique identifier of the RTG folio.
strategy The approach this RTG folio will use to achieve the aim.
targetWeights The security’s target percentage weight in the folio. The sum of the target weights will add up to 100%.
ticker The symbol of the security in the RTG folio.

Performance Data Fields

Field Description
1Month The folio’s percentage return over the past month.
1Year The folio’s percentage return over the past year. The figure will not include the current month.
3Month The folio’s percentage return over the past 3 months.
3Year The folio’s percentage return over the past 3 years. The figure will not include the current month.
5Year The folio’s percentage return over the past 5 years. The figure will not include the current month.
fundedDate This indicates the date this Ready-to-Go folio was funded on. If N/A is shown then the folio has not been funded.
inceptionDate This is the date a Ready-to-Go folio was created and made available to buy.
sinceInception The folio’s average annual percentage return since it was created. If the folio inception date was less than year ago,
the figure will be the total return since inception, instead of annualized.
volatility Volatility is one gauge of how risky it is to own a security or folio. It provides a measure of how much the price
tends to swing up and down over time. Volatility can also be referred to as standard deviation. In mathematical terms,
standard deviation refers to a range that includes the percentage distribution of returns.
yearToDate The folio’s percentage return from the beginning of the year to the date listed above the returns.

Response Example


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/rtgs/51
Content-Type: application/json
Transfer-Encoding: chunked
Date: Tue, 05 Aug 2014 19:27:42 GMT
{
  "methodology": "%3Ch3%3ESteps+to+Create+This+Folio%3C%2Fh3%3E%3Col%3E%09%3Cli%3EWe+selected+companies+with+primary+business+operations+in+the+Aerospace+sector%2C+as+defined+by+Zacks+Investment+Research.%3C%2Fli%3E%09%3Cli%3EWe+ranked+the+securities+according+to+market+capitalization+and+selected+30+securities+with+the+highest+market+capitalizations.%3C%2Fli%3E%09%3Cli%3EWe+then+equally+weighted+all+securities+in+the+folio.%3C%2Fli%3E%3C%2Fol%3E%3Ch3%3ENumber+of+Securities%3C%2Fh3%3E%3Cp%3EThere+are+generally+30+securities+in+the+folio.%3C%2Fp%3E%3Ch3%3EUpdate+Frequency%3C%2Fh3%3E%3Cp%3EQuarterly.%3C%2Fp%3E",
  "name": "Aerospace",
  "objective": "The Aerospace folio was developed for investors seeking aggressive capital growth with significant volatility.",
  "performance":    {
    "1Month": "1.29",
    "1Year": "25.53",
    "3Month": "4.23",
    "3Year": "12.02",
    "5Year": "21.21",
    "fundedDate": "08-28-2009",
    "inceptionDate": "04-05-2000",
    "sinceInception": "16.1",
    "volatility": "14.25",
    "yearToDate": "8.03"
  },
  "prePackagedFolioOid" : "51",
  "strategy": "The Aerospace folio consists of the largest companies with primary business operations in the aerospace sector. Companies range from aircraft engine manufacturers to flight information providers. A high tech industry, aerospace companies design, create, and operate aircraft, missiles, space vehicles and all related parts. The U.S., Europe, Russia, China, and India are making significant investment in the aerospace industry, and may continue do so in the future.",
  "targetWeights" : [ {
    "targetWeight" : "33.4",
    "ticker" : "ATK"
  }, {
    "targetWeight" : "33.3",
    "ticker" : "BA"
  }, {
    "targetWeight" : "33.3",
    "ticker" : "BAESY"
  } ]
}

Change Log

07/28/2017

  1. Added methodology and performance metrics in the Response Example
  2. Added description for Response Data Fields (methodology, objective performance and strategy)
  3. New table created (Performance Data Fields) with description for performance metrics

Getting Started

REST APIs

Resources

Developer Home