***ids limit** = 1000 per request*
*Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.
*\n" }, { "name": "startDate", "value": "2018-12-31", "type": "query", "description": "The start date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.\n" }, { "name": "endDate", "value": "2019-12-31", "type": "query", "description": "The end date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.\n" }, { "name": "frequency", "value": "", "type": "query", "description": "Controls the display frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\n * **M** = Monthly, based on the last trading day of the month.\n * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.).\n * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December).\n * **FQ** = Fiscal Quarter of the company.\n * **AY** = Actual Annual, based on the start date.\n * **CY** = Calendar Annual, based on the last trading day of the calendar year.\n * **FY** = Fiscal Annual, based on the last trading day of the company's fiscal year.\n" }, { "name": "currency", "value": "USD", "type": "query", "description": "Controls the Currency conversion of the Fund. By default, the currency will use the funds local currency." }, { "name": "dividendAdjust", "value": "", "type": "query", "description": "Controls the dividend inclusion for the NAV returns calculations, where - \n* DIV = Include Dividends, Total Return\n* NO_DIV = Exclude Dividends, Simple Return\n" } ] }, "docs": "Get Fund NAV Returns over a time-series for the requested date range and frequency.The simple Total Return NAV shows the fund's total return level by reinvesting distributions so that ex-date NAVs are increased by the distribution amount and compounded thereafter. Total return NAV compounds daily and is calculated from the first available NAV date of each fund. The total return NAV series reflects the value that an investor would own if it had purchased one share at the inception date and re" }, { "info": { "name": "Factset Get Fund Returns for a Requested Time-series and Large List of Ids", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-funds/v1/returns", "body": { "type": "json", "data": "{}" } }, "docs": "Get Fund NAV Returns over a time-series for the requested date range and frequency.
The simple Total Return NAV shows the fund's total return level by reinvesting distributions so that ex-date NAVs are increased by the distribution amount and compounded thereafter. Total return NAV compounds daily and is calculated from the first available NAV date of each fund. The total return NAV series reflects the value that an investor would own if it had purchased one share at the inception date and re" }, { "info": { "name": "Factset Get Fund Returns Over Pre-defined Time Horizons as of a Specific Date.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-funds/v1/returns-snapshot", "params": [ { "name": "ids", "value": "", "type": "query", "description": "The requested fund identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs.
***ids limit** = 1000 per request*
*Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.
*\n" }, { "name": "date", "value": "2018-12-31", "type": "query", "description": "The date requested for a given date range in YYYY-MM-DD format. The date MUST be equal to or less than the `priceRecentDate` found within the /summary endpoint.\n" }, { "name": "dividendAdjust", "value": "", "type": "query", "description": "Controls the dividend inclusion for the NAV returns calculations, where - \n* DIV = Include Dividends, Total Return\n* NO_DIV = Exclude Dividends, Simple Return\n" } ] }, "docs": "Get Fund Returns over pre-defined time horizons as of a specific date. Use the date parameter to set the perspective date, and adjust the return type to include or exclude dividends using the dividendAdjust parameter. Returns Ranges include - \n* oneWeek\n* oneMonth\n* threeMonth\n* yearToDate\n* oneYear\n* threeYear\n* threeYearAnnualized\n* fiveYear\n* fiveYearAnnualized\n" }, { "info": { "name": "Factset Get Fund Returns Over Pre-defined Time Horizons as of a Specific Date.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-funds/v1/returns-snapshot", "body": { "type": "json", "data": "{}" } }, "docs": "Get Fund Returns over pre-defined time horizons as of a specific date. Use the date parameter to set the perspective date, and adjust the return type to include or exclude dividends using the dividendAdjust parameter. Returns Ranges include - \n* oneWeek\n* oneMonth\n* threeMonth\n* yearToDate\n* oneYear\n* threeYear\n* threeYearAnnualized\n* fiveYear\n* fiveYearAnnualized \n" }, { "info": { "name": "Factset Get Fund Returns for a User-defined Date Range", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-funds/v1/returns-range", "params": [ { "name": "ids", "value": "", "type": "query", "description": "The requested fund identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs.***ids limit** = 1000 per request*
*Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.
*\n" }, { "name": "startDate", "value": "2018-12-31", "type": "query", "description": "The start date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to the day prior to today's previous close. The startDate cannot be equal to the endDate as no return can be computed. Additionally, the startDate MUST be equal to or greater than the `priceFirstDate` found within the /summary endpoint.\n" }, { "name": "endDate", "value": "2019-12-31", "type": "query", "description": "The end date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.\n" }, { "name": "dividendAdjust", "value": "", "type": "query", "description": "Controls the dividend inclusion for the NAV returns calculations, where - \n* DIV = Include Dividends, Total Return\n* NO_DIV = Exclude Dividends, Simple Return\n" } ] }, "docs": "Get Fund Returns between a specified startDate and endDate. The service will compute the return between those two periods to retrieve the single value and does not create a time-series. Control the return type to include or exclude dividends by using the dividendAdjust parameter.\n" }, { "info": { "name": "Factset Get Fund Returns Over Pre-defined Time Horizons as of a Specific Date for Large List of Ids.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-funds/v1/returns-range", "body": { "type": "json", "data": "{}" } }, "docs": "Get Fund Returns between a specified startDate and endDate. The service will compute the return between those two periods to retrieve the single value and does not create a time-series. Control the return type to include or exclude dividends by using the dividendAdjust parameter.\n" }, { "info": { "name": "Factset Gets Returns for a List of `ids` as of Given Date Range.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-global-prices/v1/returns", "params": [ { "name": "ids", "value": "", "type": "query", "description": "The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids.***ids limit** = 1000 per non-batch request / 2000 per batch request for a single day and 50 per multi-day request*
*Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, it's advised for any requests with large request lines to be requested through the respective \"POST\" method.
*" }, { "name": "startDate", "value": "2021-08-27", "type": "query", "description": "The start date requested for a given date range in **YYYY-MM-DD** format. The input start date must be before the input end date. Future dates (T+1) are not accepted in this endpoint.\n" }, { "name": "endDate", "value": "2021-08-27", "type": "query", "description": "The end date requested for a given date range in **YYYY-MM-DD** format. The input end date must be after the input start date. Future dates (T+1) are not accepted in this endpoint.\n" }, { "name": "currency", "value": "USD", "type": "query", "description": "Currency code for adjusting prices. Default is Local. For a list of currency ISO codes, visit [Online Assistant Page 1470](https://oa.apps.factset.com/pages/1470)." }, { "name": "frequency", "value": "", "type": "query", "description": "Controls the display frequency of the data returned.\n * **D** = Daily\n * **AD** = Actual Daily\n * **W** = Weekly, based on the last day of the week of the start date.\n * **M** = Monthly, based on the last trading day of the month.\n * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.).\n * **AQ** = Actual Quarterly\n * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December).\n * **ASA** = Actual Semi-annual\n * **CSA** = Calendar Semi-annual\n * **AY** = Actual Annual, based on the start date.\n * **CY** = Calendar Annual, based on the last trading day of the calendar year.\n \n" }, { "name": "dividendAdjust", "value": "", "type": "query", "description": "Controls the dividend reinvestment for the returns calculation.\n * **PRICE** = Price Change - Dividends Excluded.\n * **EXDATE** = Simple Return - Dividends Received on exdate but not reinvested.\n * **PAYDATE** = Simple Return - Dividends Received on paydate but not reinvested.\n * **EXDATE_C** = Compound Return - Dividends reinvested on exdate.\n * **PAYDATE_C** = Compound Return - Dividends reinvested on paydate.\n\n \n" }, { "name": "batch", "value": "", "type": "query", "description": "Enables the ability to asynchronously \"batch\" the request, supporting a long-running request for up to 20 minutes. Upon requesting batch=Y, the service will respond with an HTTP Status Code of 202.\nOnce a batch request is submitted, use batch status to see if the job has been completed. Once completed, retrieve the results of the request via batch-result. When using Batch, ids limit is increased to 10000 ids per request, though limits on query string via GET method still apply. It's advised to submit large lists of ids via POST method.\nPlease note that the number of unique currencies present in the requested ids is limited to 50 per request.\n" } ] }, "docs": "Returns for the requested ids and currency for the given dates. Depending on the input parameters the return data is provided. \n" }, { "info": { "name": "Factset Gets Returns for a List of `ids` as of Given Date Range.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-global-prices/v1/returns", "body": { "type": "json", "data": "{}" } }, "docs": "Returns for the requested ids and currency for the given dates. Depending on the input parameters the return data is provided." }, { "info": { "name": "readReturnsComposite", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/returns-composite/:id", "params": [ { "name": "id", "value": "270c2fa8-9110-444b-9101-17e10132fe0a", "type": "path", "description": "Unique identifier of the returns composite to be read" } ] }, "docs": "Read a returns composite" }, { "info": { "name": "readReturns", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/returns/:id", "params": [ { "name": "id", "value": "270c2fa8-9110-444b-9101-17e10132fe0a", "type": "path", "description": "Unique identifier of the returns to be read" } ] }, "docs": "Read a returns" }, { "info": { "name": "Factset Gets Returns for a List of `ids` as of Given Date Range and Rolling Period", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-prices/v1/returns", "params": [ { "name": "ids", "value": "", "type": "query", "description": "The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids.***ids limit** = 2000 per request*
*Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.
*" }, { "name": "startDate", "value": "2019-01-01", "type": "query", "description": "The start date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to previous close. Future dates (T+1) are not accepted in this endpoint.\n" }, { "name": "endDate", "value": "2019-12-31", "type": "query", "description": "The end date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to previous close. Future dates (T+1) are not accepted in this endpoint.\n" }, { "name": "frequency", "value": "", "type": "query", "description": "Controls the display frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\n * **M** = Monthly, based on the last trading day of the month.\n * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.).\n * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December).\n * **FQ** = Fiscal Quarter of the company.\n * **AY** = Actual Annual, based on the start date.\n * **CY** = Calendar Annual, based on the last trading day of the calendar year.\n * **FY** = Fiscal Annual, based on the last trading day of the company's fiscal year.\n" }, { "name": "calendar", "value": "FIVEDAY", "type": "query", "description": "Calendar of data returned. SEVENDAY includes weekends. LOCAL calendar will default to the securities' trading calendar which excludes date records for respective holiday periods." }, { "name": "currency", "value": "USD", "type": "query", "description": "Currency code for adjusting prices. Default is Local. For a list of currency ISO codes, visit [Online Assistant Page 1470](https://oa.apps.factset.com/pages/1470)." }, { "name": "dividendAdjust", "value": "", "type": "query", "description": "Controls the dividend reinvestment for the returns calculation.\n * **PRICE** = Price Change - Dividends Excluded\n * **EXDATE** = Simple Return - Dividends Received on exdate but not reinvested\n * **PAYDATE** = Simple Return - Dividends Received on paydate but not reinvested\n * **EXDATE_C** = Compound Return - Dividends reinvested on exdate\n * **PAYDATE_C** = Compound Return - Dividends reinvested on paydate.\n" }, { "name": "rollingPeriod", "value": "", "type": "query", "description": "Period of measure for the rolling cumulative return. This does not change display `frequency` but rather the underlying return calculation period. All periods are referencing actual periods of measure, not period-ends. For example, 1M rolling period will go back to that date the previous month, which is not always the month-end date." } ] }, "docs": "The simple or compound return for the requested frequency and/or rollingPeriod. Depending on the input parameters the return will adjust accordingly. If you simply use frequency and no rollingPeriod, the return value will represent the frequency period. If you use rollingPeriod, the values will be returned in actual period ends (e.g. actual month, actual week, daily, etc.). General Return Calculation Details found on [Online Assistant Page #8748](https://oa.apps.factset.com/pages/8748)" }, { "info": { "name": "Factset Requests Security Returns for the Given Date Range and Rollingperiod.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-prices/v1/returns", "body": { "type": "json", "data": "{}" } }, "docs": "The simple or compound return for the requested frequency and/or rollingPeriod. Depending on the input parameters the return will adjust accordingly. If you simply use frequency and no rollingPeriod, the return value will represent the frequency period. If you use rollingPeriod, the values will be returned in actual period ends (e.g. actual month, actual week, daily, etc.). General Return Calculation Details found on [Online Assistant Page #8748](https://oa.apps.factset.com/pages/8748)" }, { "info": { "name": "Factset Returns the Price Performance of the Security and Annualized Compound Total Returns.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-prices/v1/returns-snapshot", "params": [ { "name": "ids", "value": "", "type": "query", "description": "The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids.***ids limit** = 2000 per request*
*Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.
*" }, { "name": "date", "value": "2019-07-07", "type": "query", "description": "The date in **YYYY-MM-DD** format. This controls the perspective dates to the calculate the returns. If left blank, the API will default to previous close. Future dates (T+1) are not accepted in this endpoint.\n" }, { "name": "calendar", "value": "FIVEDAY", "type": "query", "description": "Calendar of data returned. SEVENDAY includes weekends. LOCAL calendar will default to the securities' trading calendar which excludes date records for respective holiday periods." }, { "name": "currency", "value": "USD", "type": "query", "description": "Currency code for adjusting prices. Default is Local. For a list of currency ISO codes, visit [Online Assistant Page 1470](https://oa.apps.factset.com/pages/1470)." }, { "name": "dividendAdjust", "value": "", "type": "query", "description": "Controls the dividend reinvestment for the returns calculation. Dividends will be reinvested on the date the dividends go ex (when the dividends belong to the seller rather than the buyer). Visit [OA 8748](https://my.apps.factset.com/oa/pages/8748) for calculation methodology.\n * **PRICE** = Price Change - Dividends Excluded.\n * **EXDATE** = Simple Return - Dividends Received on exdate but not reinvested. Dividends accumulated throughout the specified period are added to the price at the end of the period.\n * **EXDATE_C** = Compound Return - Dividends reinvested on exdate. Dividends accumulated throughout the specified period are used to buy more shares of stock in the company.\n" } ] }, "docs": "Retrieves various return periods as of a given date for a requested list of securities. This endpoint is very helpful for quickly retrieving a list of pre-calculated returns for application development.Return periods include\n * oneDay\n * weekToDate\n * monthToDate\n * quarterToDate\n * yearToDate\n * oneMonth\n * threeMonth\n * sixMonth\n * nineMonth\n * oneYear\n * twoYearAnnualized\n * threeYearAnnualized\n * fiveYearAnnualized\n * tenYearAnnualized\n * twentyYearAnnualized\n * thirtyYea" }, { "info": { "name": "Factset Returns the Price Performance of the Security and Annualized Compound Total Returns.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-prices/v1/returns-snapshot", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves various return periods as of a given date for a requested list of securities. This endpoint is very helpful for quickly retrieving a list of pre-calculated returns for application development.
Return periods include\n * oneDay\n * weekToDate\n * monthToDate\n * quarterToDate\n * yearToDate\n * oneMonth\n * threeMonth\n * sixMonth\n * nineMonth\n * oneYear\n * twoYearAnnualized\n * threeYearAnnualized\n * fiveYearAnnualized\n * tenYearAnnualized\n * twentyYearAnnualized\n * thirtyYea" }, { "info": { "name": "Factset Get Spar Account Returns Type Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/accounts/:accountPath/returns-type", "params": [ { "name": "accountPath", "value": "", "type": "path", "description": "URL encoded account path" } ] }, "docs": "This endpoint returns the returns type of account associated with SPAR" } ] } ], "bundled": true }