***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 Request a Snapshot of Exchange Data for a List of Symbols.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/DFSnapshot", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Requested symbols or securities. **Required** if not using `oc`. This is a comma-seperated list with a maximum of 500. Each symbol can be a FactSet Exchange Symbol, CUSIP, or SEDOL. This can be used in combination with `chain` parameter to pull in a custom portfolio.**Try it out** - Choose one or multiple - IBM-USA, BABA-USA, WALMEX-MX, 7203-TKS, VOD-LON, NPN-JSE, MABAX, NZF, SPY-USA, AGG-USA, GLD-USA, AOR-USA, MNA-USA, UUP-USA, SP50-SPX, ESX-STX, XAO-ASX, WD-MSX, NG00-USA, GC00-USA, CC00-USA, C00-USA, FC00-USA, ER00-USA, EURUSD-FX1, USDMXN-FX1, AUDJPY-FX1, EURCZK-FX1, USDILS-FX1, USDZAR-FX1, US10YY-TU1, FDS#190621C00145000-USA, FDS#190621P00145000-USA. *Leave blank if you are trying the `oc` parameter*.
" }, { "name": "oc", "value": "", "type": "query", "description": "Option Chain, accepts one underlying symbol for which the option chain will be returned. **Required** if not using `ids`.**Try it Out** - Only available for BABA-USA
" }, { "name": "fields", "value": "", "type": "query", "description": "All available fields. This is a comma-seperated list (no spaces). **Required** only when using `oc`. Otherwise, leave blank to return all fields by default. See definitions for details on available field names and Field ID #s. The Data Service Manual has complete reference.**Try it Out** - All fields available. Use either FID # or name. For `oc`, recommend to use BID_1,ASK_1,STRIKE_PRICE." }, { "name": "sf", "value": "", "type": "query", "description": "Symbol Filters, ability to apply filtering to the result of an option chain `oc` request based on available fields and values for the symbols. `sf`=VALUE_[filter],[field],[value]\n * **VALUE_MINMAX** - Field value will be within specified interval. ex. - VALUE_MINMAX,BID_1,min,max\n * **VALUE_EQUALS** - Field value will equal specified value. ex. - VALUE_EQUALS,BID_1,value\n * **VALUE_NOT_EQUALS** - Field value will not equal specified value. ex. - VALUE_NOT_EQUALS,BID_1,value\n \n **Try it Out** - depends on fields used. Example - VALUE_MINMAX,STRIKE_PRICE,120,130 \n" }, { "name": "format", "value": "", "type": "query", "description": "The format of the output file.
**Try it Out** - All formats available
" }, { "name": "serv", "value": "", "type": "query", "description": "The Data Service that handles the request for the specified symbols. Available live services are - \n * **FDS1** -Production Data Service\n * **FDS_FUND** -Fundamental Data Service used for End-of-Day data.\n\n**Try it Out** - use FDS1\n" }, { "name": "req_id", "value": "", "type": "query", "description": "Request Identification String. Can be used by the application to keep track of requests. The id is not used by this service, however, it is included in the XML response.**Try it Out** - any value can be passed through.
" } ] }, "docs": "\n`ids` and `oc` are required parameters, but only one can be used based on request. Use `ids` for regular snapshot requests, and `oc` for requesting an option chain. \n\n**Try it Out** feature is available using a pre-recorded sandbox environment. Follow Try it Out inscrutions on each parameter to develop a request and view a sample server response.\n\n'*You must be logged into the Developer Portal and obtain an **[API Key](https://developer.factset.com/factset/api-key-listing)** for ''Try it Out'' " }, { "info": { "name": "Factset Snap Exchange Data. Use if Url Lengh of 2,048 Is Exceeded.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/DFSnapshot", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Requested symbols or securities. **Required** if not using `oc`. This is a comma-seperated list with a maximum of 500. Each symbol can be a FactSet Exchange Symbol, CUSIP, or SEDOL. This can be used in combination with `chain` parameter to pull in a custom portfolio.**Try it out** - Choose one or multiple - IBM-USA, BABA-USA, WALMEX-MX, 7203-TKS, VOD-LON, NPN-JSE, MABAX, NZF, SPY-USA, AGG-USA, GLD-USA, AOR-USA, MNA-USA, UUP-USA, SP50-SPX, ESX-STX, XAO-ASX, WD-MSX, NG00-USA, GC00-USA, CC00-USA, C00-USA, FC00-USA, ER00-USA, EURUSD-FX1, USDMXN-FX1, AUDJPY-FX1, EURCZK-FX1, USDILS-FX1, USDZAR-FX1, US10YY-TU1, FDS#190621C00145000-USA, FDS#190621P00145000-USA. *Leave blank if you are trying the `oc` parameter*.
" }, { "name": "oc", "value": "", "type": "query", "description": "Option Chain, accepts one underlying symbol for which the option chain will be returned. **Required** if not using `ids`.**Try it Out** - Only available for BABA-USA
" }, { "name": "fields", "value": "", "type": "query", "description": "All available fields. This is a comma-seperated list (no spaces). **Required** only when using `oc`. Otherwise, leave blank to return all fields by default. See definitions for details on available field names and Field ID #s. The Data Service Manual has complete reference.**Try it Out** - All fields available. Use either FID # or name. For `oc`, recommend to use BID_1,ASK_1,STRIKE_PRICE." }, { "name": "sf", "value": "", "type": "query", "description": "Symbol Filters, ability to apply filtering to the result of an option chain `oc` request based on available fields and values for the symbols. `sf`=VALUE_[filter],[field],[value]\n * **VALUE_MINMAX** - Field value will be within specified interval. ex. - VALUE_MINMAX,BID_1,min,max\n * **VALUE_EQUALS** - Field value will equal specified value. ex. - VALUE_EQUALS,BID_1,value\n * **VALUE_NOT_EQUALS** - Field value will not equal specified value. ex. - VALUE_NOT_EQUALS,BID_1,value\n \n **Try it Out** - depends on fields used. Example - VALUE_MINMAX,STRIKE_PRICE,120,130 \n" }, { "name": "format", "value": "", "type": "query", "description": "The format of the output file.
**Try it Out** - All formats available
" }, { "name": "serv", "value": "", "type": "query", "description": "The Data Service that handles the request for the specified symbols. Available live services are - \n * **FDS1** -Production Data Service\n * **FDS_FUND** -Fundamental Data Service used for End-of-Day data.\n\n**Try it Out** - use FDS1\n" }, { "name": "req_id", "value": "", "type": "query", "description": "Request Identification String. Can be used by the application to keep track of requests. The id is not used by this service, however, it is included in the XML response.**Try it Out** - any value can be passed through.
" } ] }, "docs": "Request Snapshot exchange data. Use POST when your URL length exceeds 2,048 characters." }, { "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 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" } ] } ], "bundled": true }