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

Get All RTG Folios

This request returns the list of Ready-to-Go (RTG) folio models to which folios in member’s brokerage accounts can be subscribed.

Request URL

Syntax GET /restapi/rtgs
Example URL https://testapi.foliofn.com/restapi/rtgs?categorytype=S

Response Data Fields

Field Description
category The category of the RTG folio.
categoryType Identifier of the RTG category type.
description The description of the RTG folio.
name The name of the RTG folio.
performance An array of performance metrics for this RTG folio.
prePackagedFolioOid The unique identifier of 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.

Category and CategoryType Codes

Category Type Category
A Archived
D Bond
F Strategy
G Geographic
I Market Index
N Fundamental
R Investment Style
S Sector/Industry
T Target Date
X Asset Allocation

Response Example without query parameter


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
Content-Type: application/json
Transfer-Encoding: chunked
Date: Tue, 05 Aug 2014 19:24:21 GMT
[
 {
  "category" : "Sector/Industry",
  "categoryType" : "S",
  "description" : "Aerospace Folio Folio Reviewed: 04/03/2017. Folio Changed: 04/03/2017 (12:00 AM).",
  "name" : "Aerospace",
  "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"
},
 {
  "category" : "Geographic",
  "categoryType" : "G",
  "description" : "Africa Folio Folio Reviewed: 04/03/2017. Folio Changed: 04/03/2017 (12:00 AM).",
  "name" : "Africa",
  "performance":    {
    "1Month": "-2.83",
    "1Year": "1.8",
    "3Month": "-3.52",
    "3Year": "-6.03",
    "5Year": "-1.94",
    "fundedDate": "08-31-2009",
    "inceptionDate": "04-05-2000",
    "sinceInception": "9.16",
    "volatility": "23.07",
    "yearToDate": "6.34"
  },
  "prePackagedFolioOid" : "2"
},
 {
  "category" : "Investment Style",
  "categoryType" : "R",
  "description" : "Aggressive Folio Reviewed: 04/03/2017. Folio Changed: 04/03/2017 (12:00 AM).",
  "name" : "Aggressive",
  "performance":    {
    "1Month": "1.41",
    "1Year": "18.12",
    "3Month": "5.53",
    "3Year": "8.67",
    "5Year": "14.53",
    "fundedDate": "08-28-2009",
    "inceptionDate": "04-05-2000",
    "sinceInception": "5.82",
    "volatility": "12.31",
    "yearToDate": "12.91"
  },
  "prePackagedFolioOid" : "3"
}]

Response Example with query parameter


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?categorytype=S
Content-Type: application/json
Transfer-Encoding: chunked
Date: Tue, 05 Aug 2014 19:24:21 GMT
[
 {
  "category" : "Sector/Industry",
  "categoryType" : "S",
  "description" : "Aerospace Folio Folio Reviewed: 04/03/2017. Folio Changed: 04/03/2017 (12:00 AM).",
  "name" : "Aerospace",
  "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"
},
 {
  "category" : "Sector/Industry",
  "categoryType" : "S",
  "description" : "Utility Folio Reviewed: 06/05/2017. Folio Changed: 06/05/2017 (12:00 AM).",
  "name" : "Utility",
  "performance":    {
    "1Month": "-2.83",
    "1Year": "1.8",
    "3Month": "-3.52",
    "3Year": "-6.03",
    "5Year": "-1.94",
    "fundedDate": "08-31-2009",
    "inceptionDate": "04-05-2000",
    "sinceInception": "9.16",
    "volatility": "23.07",
    "yearToDate": "6.34"
  },
  "prePackagedFolioOid" : "54"
},
 {
  "category" : "Sector/Industry",
  "categoryType" : "S",
  "description" : "Wine Beer and Spirits Folio Reviewed: 04/03/2017. Folio Changed: 04/03/2017 (12:00 AM).",
  "name" : "Wine Beer and Spirits",
  "performance":    {
    "1Month": "-2.83",
    "1Year": "1.8",
    "3Month": "-3.52",
    "3Year": "-6.03",
    "5Year": "-1.94",
    "fundedDate": "08-31-2009",
    "inceptionDate": "04-05-2000",
    "sinceInception": "9.16",
    "volatility": "23.07",
    "yearToDate": "6.34"
  },
  "prePackagedFolioOid" : "154"
}]

Change Log

07/28/2017

  1. Added query parameter 'categorytype'
  2. Modified Response Examples to reflect instances with and without 'categorytype'
  3. Added performance metrics in the Response Example
  4. Added description for performance in Response Data Fields
  5. New table created (Performance Data Fields) with description for performance metrics

Getting Started

REST APIs

Resources

Developer Home