{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About DFSnapshot API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "DFSnapshot", "type": "folder" }, "items": [ { "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." } ] } ], "bundled": true }