{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About Factset Benchmarks API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Factset Benchmarks", "type": "folder" }, "items": [ { "info": { "name": "Factset Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-benchmarks/v1/constituents", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of valid identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error.

***ids limit** = 1 per request*

" }, { "name": "date", "value": "", "type": "query", "description": "Date of holding expressed in YYYY-MM-DD format." }, { "name": "currency", "value": "", "type": "query", "description": "Currency for response." }, { "name": "calendar", "value": "", "type": "query", "description": "Calendar of data returned. The default value is FIVEDAY which displays Monday through Friday, regardless of whether there were trading holidays." } ] }, "docs": "Returns the requested Benchmark Constituents and respective Weights, Price and Market Value. You must be authorized for the `ids` requested. Use the helper endpoint **/id-list** for valid identifiers. \n" }, { "info": { "name": "Factset Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-benchmarks/v1/constituents", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the requested Benchmark Constituents and respective Weights, Price and Market Value. You must be authorized for the `ids` requested. Use the helper endpoint **/id-list** for valid identifiers.\n" }, { "info": { "name": "Factset Returns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-benchmarks/v1/fixed-income-constituents", "params": [ { "name": "ids", "value": "LHMN0001", "type": "query", "description": "Fixed Income Benchmark Identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error.

***ids limit** = 1 per request*

" }, { "name": "date", "value": "", "type": "query", "description": "Date of holding expressed in YYYY-MM-DD format." }, { "name": "currency", "value": "", "type": "query", "description": "Currency for response." } ] }, "docs": "Returns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value. You must be authorized for the `ids` requested.\n" }, { "info": { "name": "Factset Returns the requested Benchmark Constituents and respective Weights, Price and Market Value.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-benchmarks/v1/fixed-income-constituents", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value. You must be authorized for the `ids` requested.\n" }, { "info": { "name": "Factset Index Level Prices, Returns, and related information as of a single date.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-benchmarks/v1/index-snapshot", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of valid identifiers.

***ids limit** = 500 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": "", "type": "query", "description": "Date of holding expressed in YYYY-MM-DD format." }, { "name": "returnType", "value": "", "type": "query", "description": "The return type adjustment used in returns response items. Adjustment can be made for GROSS and NET dividends that will be included in the return calculation. The service will default to GROSS." }, { "name": "currency", "value": "", "type": "query", "description": "Currency for response." }, { "name": "calendar", "value": "FIVEDAY", "type": "query", "description": "Calendar of data returned. SEVENDAY includes weekends." } ] }, "docs": "Retrieves Index Level Prices and Returns information as of a specific date. Simply submit a valid Benchmark ID (you can use the /id-list endpoint for a sample list of ids), and date and retrieve Index Level Prices, Returns, and related information.\n" }, { "info": { "name": "Factset Retrieves the Index Level Snapshot of Prices and Returns information for a given identifier and single date.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-benchmarks/v1/index-snapshot", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves Index Level Prices and Returns information as aligned with FactSet's Benchmark Data Feed solution. Simply submit a valid Benchmark ID (you can use the /id-list endpoint for a sample list of ids), and date and retrieve Index Level Prices, Returns, and related information.\n" }, { "info": { "name": "Factset Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-benchmarks/v1/index-history", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of valid identifiers.

***ids limit** = 500 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": "", "type": "query", "description": "Requested start date expressed in YYYY-MM-DD format." }, { "name": "endDate", "value": "", "type": "query", "description": "Requested End Date for Range expressed in YYYY-MM-DD format." }, { "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 * **AY** = Actual Annual, based on the start date.\n * **CY** = Calendar Annual, based on the last trading day of the calendar year.\n" }, { "name": "returnType", "value": "", "type": "query", "description": "The return type adjustment used in returns response items. Adjustment can be made for GROSS and NET dividends that will be included in the return calculation. The service will default to GROSS." }, { "name": "hedgeType", "value": "", "type": "query", "description": "The hedge type adjustment used in returns response items. Adjustment can be made for HEDGED and UNHEDGED values that will be included in the return calculation. The service will default to UNHEDGED." }, { "name": "currency", "value": "", "type": "query", "description": "Currency for response." }, { "name": "calendar", "value": "FIVEDAY", "type": "query", "description": "Calendar of data returned. SEVENDAY includes weekends." }, { "name": "impliedDate", "value": "", "type": "query", "description": "This parameter controls the **date** returned in the date field. The default value is **N**. By default, the date field returns the actual date of the observation. This means it will repeat values for weekends and holidays. If set to **Y**, the date field will return the implied date of the observation, making all the dates unique." } ] }, "docs": "Retrieves Index Level Prices and Returns information as of a date range requested. Simply submit a valid Benchmark ID (you can use the /id-list endpoint for a sample list of ids), and date range to retrieve Index Level Prices, Returns, and related information.\n" }, { "info": { "name": "Factset Retrieves Index Level Prices and Returns information for a list of identifiers and historical date range.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-benchmarks/v1/index-history", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves Index Level Prices and Returns information as aligned with FactSet's Benchmark Data Feed solution. Simply submit a valid Benchmark ID (you can use the /id-list endpoint for a sample list of ids), and date and retrieve Index Level Prices, Returns, and related information.\n" }, { "info": { "name": "Factset Returns the aggregated ratios of a requested benchmark", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-benchmarks/v1/ratios", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of valid identifiers.

***ids limit** = 500 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": "metrics", "value": "", "type": "query", "description": "Requested List of FactSet Market Aggregates (FMA) or ratios. provided the below complete metrics list.\n|metric item|Description|category|periodicity\n|:|:|:|:|\n|GROSS_MARGIN|Gross Margin|Profitability (%)|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2\n|OPER_INC_SALES|Operating Margin|Profitability (%)|LTM, QTR\n|NET_MGN|Net Margin|Profitability (%)|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2\n|EBIT_MARGIN|EBIT Margin|Profitability (%)| NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2\n|EBITDA_MARGIN|EBITDA Margin|Profitability (%)|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2\n|ROA|Return on Assets|Profitability (%)|LTM\n|ROE|Return on Equity|Profitability (%)|NTMA, LTMA, LTM, 0, 1, 2\n|ROIC|Return on Invested Capital|Profitability (%)| LTM\n|FCF_MGN|Free Cash Flow Margin|Profitability (%)|LTM, QTR\n|PE|Price/Earnings|Valuation|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2\n|PEX|Price/Earnings (excl negatives)|Valuation|LTM\n|PSALES|Price/Sales|Valuation|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2\n|PBK|Price/Book Value|Valuation|NTMA, LTMA, LTM, 0, 1, 2\n|PCF|Price/Cash Flow|Valuation|NTMA, LTMA, LTM, 0, 1, 2\n|PCFX|Price/Cash Flow (excl negatives)|Valuation|LTM\n|PFCF|Price/Free Cash Flow|Valuation|NTMA, LTMA, LTM, 0, 1, 2\n|EVAL_EBIT|Enterprise Value/EBIT|Valuation|NTMA, LTMA, LTM, 0, 1, 2\n|EVAL_EBITDA|Enterprise Value/EBITDA|Valuation|NTMA, LTMA, LTM, 0, 1, 2\n|EVAL_SALES|Enterprise Value/Sales|Valuation|NTMA, LTMA, LTM, 0, 1, 2\n|NDEBT_EBITDA|Net Debt/EBITDA|Coverage|NTMA, LTMA, LTM, 0, 1, 2\n|NDEBT_EBITDA_MIN_CAPEX|Net Debt/(EBITDA-Capex)|Coverage|LTM\n|DEBT_EBITDA|Total Debt/EBITDA|Coverage|LTM\n|DEBT_EBIT|Total Debt/EBIT|Coverage|LTM\n|EBIT_INT_EXP|EBIT/Interest Expense (Int. Coverage)|Coverage|LTM\n|EBITDA_INT_EXP|EBITDA/Interest Expense|Coverage|LTM\n|OPER_CF_INT_EXP|CFO/Interest Expense|Coverage|LTM\n|LTD_EBITDA|LT Debt/EBITDA|Coverage|LTM\n|NDEBT_FFO|Net Debt/FFO|Coverage|LTM\n|LTD_FFO|LT Debt/FFO|Coverage|LTM\n|FCF_DEBT|FCF/Total Debt|Coverage|LTM\n|OPER_CF_DEBT|CFO/Total Debt|Coverage|LTM\n|LTD_EQ|LT Debt/Total Equity|Leverage(%)|LTM\n|LTD_TCAP|LT Debt/Total Capital|Leverage(%)|LTM\n|LTD_ASSETS|LT Debt/Total Assets|Leverage(%)|LTM\n|DEBT_ASSETS|Total Debt/Total Assets|Leverage(%)|LTM\n|DEBT_EQ|Total Debt/Total Equity|Leverage(%)|LTM\n|NDEBT_TCAP|Net Debt/Total Capital|Leverage(%)|LTM\n|DEBT_TCAP|Total Debt/Total Capital|Leverage(%)|LTM\n|

***metrics limit** = 38 per request*

\n*

Make note, GET Method URL request lines are also limited to a total\nlength of 8192 bytes (8KB). In cases where the service allows for thousands\nof ids, which may lead to exceeding this request line limit of 8KB, its\nadvised for any requests with large request lines to be requested through\nthe respective \"POST\" method.

*\n" }, { "name": "startDate", "value": "", "type": "query", "description": "Requested start date expressed in YYYY-MM-DD format." }, { "name": "endDate", "value": "", "type": "query", "description": "Requested End Date for Range expressed in YYYY-MM-DD format." }, { "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 * **AY** = Actual Annual, based on the start date.\n * **CY** = Calendar Annual, based on the last trading day of the calendar year.\n" }, { "name": "periodicity", "value": "", "type": "query", "description": "The calculation periodicity for the aggregated period. **Note** - Not all periodicities are supported for each metric, depending on the type of ratio. LTM is set as default and supported for all metrics. See Metrics Parameter for additional detail on which periodicities are available per metric.\n|Periodicity| Description|\n|:|:|\n|LTM| Last Twelve Months\n|LTMA| Last Twelve Months using Broker Actuals for Estimated Items\n|STMA| Second Twelve Month Forward\n|NTMA| 12 Month Forward\n|0| Latest Reported Calendar Year\n|1| Current Unreported Year\n|2| Following Year\n|QTR| Quarterly - Reported by companies\n" }, { "name": "currency", "value": "", "type": "query", "description": "Currency for response." } ] }, "docs": "Retrieves the index level ratios for a requested benchmark. Ratios supported are expressed through metrics parameter, and include Categories of Profitability, Valuation, Coverage, and Leverage.

Using FactSet Market Aggregates, the service combines fundamental, estimates, and pricing content to derive ratios and per share values for global equity market indexes and commercial benchmark vendors. The constituents of the index are fetched on rolling basis over time period requested, and then the" }, { "info": { "name": "Factset Returns the aggregated ratios of a requested benchmark", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-benchmarks/v1/ratios", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves the index level ratios for a requested benchmark. Ratios supported are expressed through metrics parameter, and include Categories of Profitability, Valuation, Coverage, and Leverage.

Using FactSet Market Aggregates, the service combines FactSet Fundamental, FactSet Estimates, and FactSet Pricing content to derive ratios and per share values for global equity market indexes and commercial benchmark vendors. The constituents of the index are fetched on rolling basis over time period" }, { "info": { "name": "Factset Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-benchmarks/v1/id-list", "params": [ { "name": "familyFilter", "value": "", "type": "query", "description": "Highest Level Filter to search by common Benchmark Families, such as S&P, MSCI, or Russell. This will retrieve all related benchmark ids. For further filtering, use the response items such as the categoryDescription field. Leave blank if you wish to see a full sample list of ids. requested-\n* **CHINA & HK INDICES** - Major Hong Kong and China Indices, such as Hang Seng Index (HSI-HKX)\n* **DOW JONES** - Dow Jones Global, Regions, Countries, Titans.\n* **FACTSET MARKET INDICES** - Regional and Country Indices defined by FactSet\n* **FTSE** - FTSE Global, UK, Global All Cap, World, Xinhua, European, GWA, JSE, Multinationals, and Style indices\n* **GLOBAL INDICES** - A mix of major indices across the globe.\n* **MSCI** - MSCI All Country, Asia Pacific, Thematic & Strategy, Emerging, Developed, US.\n* **RUSSELL** - US, Global, and Nomura.\n* **S&P** - US, ASX, Select Industry, BMI, Global, Thematic, Emerging, TSX.\n* **STOXX** - Total Market, Europe, and Nordic\n* **TOPIX** - Topix Indices, such as TOPIX 500 (182301)\n" } ] }, "docs": "Returns a **sample** list of Benchmark Identifiers to use in other Benchmark API endpoints. This is a supporting API to be use alongside the other Benchmark API endpoints. For example, use the fsymID value returned in this response as the input to your `ids` parameter in the /constituents endpoint to return constituents for that id.

*This is not the full list of benchmark ids allowed in this service, but rather a representation of the most commonly requested. For complete assistance with ID l" }, { "info": { "name": "Factset Returns a sample list of Benchmark Identifiers and the benchmark categorization to use in other Benchmark API endpoints.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-benchmarks/v1/id-list", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a **sample** list of Benchmark Identifiers to use in other Benchmark API endpoints. This is a supporting API to be use alongside the other Benchmark API endpoints. For example, use the fsymID value returned in this response as the input to your `ids` parameter in the /constituents endpoint to return constituents for that id.

*This is not the full list of benchmark ids allowed in this service, but rather a representation of the most commonly requested. For complete assistance with ID l" } ] } ], "bundled": true }