{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About Consensus API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Consensus", "type": "folder" }, "items": [ { "info": { "name": "Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-estimates/v2/rolling-consensus", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input.
***ids limit** = 3000 per request*
* Make Note - id limit of 3000 for defaults, otherwise the service is limited to a 30 second duration. This can be reached when increasing total number of metrics requested and depth of history. *\n" }, { "name": "metrics", "value": "", "type": "query", "description": "Requested metrics. Use the /metrics endpoint to return a list of available estimate items. Note, the number of metrics you are allowed to supply is limited to 1 for now. **Top 10** most used metrics are **EPS, SALES, DPS, EBITDA,EBIT, PRICE_TGT, CFPS, BPS, NET_INC, and ASSETS**. For more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034).\n" }, { "name": "startDate", "value": "2019-07-30", "type": "query", "description": "Start date for point in time of estimates expressed in YYYY-MM-DD format." }, { "name": "endDate", "value": "2020-07-30", "type": "query", "description": "End date for point in time of estimates expressed in YYYY-MM-DD format." }, { "name": "frequency", "value": "", "type": "query", "description": "Controls the frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\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** = Quarterly, based on the start date.\n * **AY** = Actual Annual, based on the start date. \n" }, { "name": "relativeFiscalStart", "value": "1", "type": "query", "description": "Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 1 and periodicity to ANN to ask for relative Fiscal Year 1 (FY1)." }, { "name": "relativeFiscalEnd", "value": "3", "type": "query", "description": "Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 2 and periodicity to ANN to ask for relative Fiscal Year 1 (FY2)." }, { "name": "periodicity", "value": "", "type": "query", "description": "The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, Annual, and NTMA/LTMA Estimates.\n * **ANN** - Annual\n * **QTR** - Quarterly\n * **SEMI** - Semi-Annual \n * **NTMA** - Next-Twelve-Months - Time-weighted Annual. Estimates use a percentage of annual estimates from two fiscal years to create an estimate based on the 12-month period. Visit [OA 16614](https://my.apps.factset.com/oa/pages/16614)\nfor detail.\n * **LTMA** - Last-Twelve-Months - Time-weighted Annual. Estimates use a percentage of annual estimates from two fiscal years to create an estimate based on the 12-month period. Visit [OA 16614](https://my.apps.factset.com/oa/pages/16614)\nfor detail.\n \n" }, { "name": "currency", "value": "USD", "type": "query", "description": "Currency code for adjusting the data. Use 'ESTIMATE' as input value for the values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470)." } ] }, "docs": "Returns FactSet Estimates consensus data using rolling fiscal dates.The rolling behavior causes fiscal year to automatically roll from one year to the next as the historical perspective date changes. The fiscal period rolls forward as of each period end. This endpoint is optimized to allow the request to simply include a relative fiscal period (e.g. use relativeFiscalStart integer 1 and periodicity ANN for next unreported fiscal year end), and then see what the consensus thought the \"next fi" }, { "info": { "name": "Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-estimates/v2/rolling-consensus", "body": { "type": "json", "data": "{}" } }, "docs": "Returns FactSet Estimates consensus data using rolling fiscal dates.
The rolling behavior causes fiscal year to automatically roll from one year to the next as the historical perspective date changes. The fiscal period rolls forward as of each period end. This endpoint is optimized to allow the request to simply include a relative fiscal period (e.g. use relativeFiscalStart integer 1 and periodicity ANN for next unreported fiscal year end), and then see what the consensus thought the \"next fi" }, { "info": { "name": "Factset Retrieves Consensus Estimates for a Requested List of Ids and Fixed Fiscal Periods", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-estimates/v2/fixed-consensus", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input.
***ids limit** = 3000 per request*
* Make Note - id limit of 3000 for defaults, otherwise the service is limited to a 30 second duration. This can be reached when increasing total number of metrics requested and depth of history. *\n" }, { "name": "metrics", "value": "", "type": "query", "description": "Requested metrics. Use the /metrics endpoint to return a list of available estimate items. Note, the number of metrics you are allowed to supply is limited to 1 for now. **Top 10** most used metrics are **EPS, SALES, DPS, EBITDA,EBIT, PRICE_TGT, CFPS, BPS, NET_INC, and ASSETS**. For more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034).\n" }, { "name": "startDate", "value": "2019-07-30", "type": "query", "description": "Start date for point in time of estimates expressed in YYYY-MM-DD format." }, { "name": "endDate", "value": "2020-07-30", "type": "query", "description": "End date for point in time of estimates expressed in YYYY-MM-DD format." }, { "name": "frequency", "value": "", "type": "query", "description": "Controls the frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\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** = Quarterly, based on the start date.\n * **AY** = Actual Annual, based on the start date. \n" }, { "name": "fiscalPeriodStart", "value": "2019", "type": "query", "description": "Fiscal period start expressed in absolute date formats. Date that will fall back to most recent completed period during resolution.\n * **Fiscal Quarter-end** - YYYY/FQ (e.g., 2019/1F, 2019/2F, 2019/3F, 2019/4F)\n * **Fiscal Year-end** - YYYY (e.g. 2019)\n" }, { "name": "fiscalPeriodEnd", "value": "2020", "type": "query", "description": "Fiscal period start expressed in absolute date formats. Date that will fall back to most recent completed period during resolution.\n * **Fiscal Quarter-end** - YYYY/FQ (e.g., 2019/1F, 2019/2F, 2019/3F, 2019/4F)\n * **Fiscal Year-end** - YYYY (e.g. 2019)\n" }, { "name": "periodicity", "value": "", "type": "query", "description": "The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, Annual, and NTMA/LTMA Estimates.\n * **ANN** - Annual\n * **QTR** - Quarterly\n * **SEMI** - Semi-Annual \n * **NTMA** - Next-Twelve-Months - Time-weighted Annual. Estimates use a percentage of annual estimates from two fiscal years to create an estimate based on the 12-month period. Visit [OA 16614](https://my.apps.factset.com/oa/pages/16614)\nfor detail.\n * **LTMA** - Last-Twelve-Months - Time-weighted Annual. Estimates use a percentage of annual estimates from two fiscal years to create an estimate based on the 12-month period. Visit [OA 16614](https://my.apps.factset.com/oa/pages/16614)\nfor detail.\n \n" }, { "name": "currency", "value": "USD", "type": "query", "description": "Currency code for adjusting the data. Use 'ESTIMATE' as input value for the values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470)." } ] }, "docs": "Returns FactSet Estimates consensus data using fixed fiscal dates. For example, if the company's current unreported year is 12/2020, all data returned by formulas that specify as the period/report basis will be for 12/2005 regardless of what perspective dates (startDate/endDate) are used. The fixed dates are \"locked\" in time and all estimated values are for that explicit date. If you are requesting that the estimated periods can change with the perspective date, please use the rolling-consensus " }, { "info": { "name": "Factset Consensus Estimates for Fixed Fiscal Periods", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-estimates/v2/fixed-consensus", "body": { "type": "json", "data": "{}" } }, "docs": "Returns FactSet Estimates consensus data using fixed fiscal dates. For example, if the company's current unreported year is 12/2020, all data returned by formulas that specify as the period/report basis will be for 12/2005 regardless of what perspective dates (startDate/endDate) are used. The fixed dates are \"locked\" in time and all estimated values are for that explicit date. If you are requesting that the estimated periods can change with the perspective date, please use the rolling-consensus " }, { "info": { "name": "Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-estimates/v2/consensus-ratings", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input.***ids limit** = 3000 per request*
* Make Note - id limit of 3000 for defaults, otherwise the service is limited to a 30 second duration. This can be reached when increasing total number of metrics requested and depth of history. *\n" }, { "name": "startDate", "value": "2019-07-30", "type": "query", "description": "Start date for point in time of estimates expressed in YYYY-MM-DD format." }, { "name": "endDate", "value": "2020-07-30", "type": "query", "description": "End date for point in time of estimates expressed in YYYY-MM-DD format." }, { "name": "frequency", "value": "", "type": "query", "description": "Controls the frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\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** = Quarterly, based on the start date.\n * **AY** = Actual Annual, based on the start date. \n" } ] }, "docs": "Returns ratings from the FactSet Estimates database for current and historical for an individual security using rolling fiscal dates as of a specific date.\n" }, { "info": { "name": "Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-estimates/v2/consensus-ratings", "body": { "type": "json", "data": "{}" } }, "docs": "Returns ratings from the FactSet Estimates database for current and historical for an individual security using rolling fiscal dates as of a specific date.\n" } ] } ], "bundled": true }