FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList
0.21.11
Prefix Reserved
dotnet add package FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList --version 0.21.11
NuGet\Install-Package FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList -Version 0.21.11
<PackageReference Include="FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList" Version="0.21.11" />
paket add FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList --version 0.21.11
#r "nuget: FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList, 0.21.11"
// Install FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList as a Cake Addin #addin nuget:?package=FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList&version=0.21.11 // Install FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList as a Cake Tool #tool nuget:?package=FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList&version=0.21.11
Exchange DataFeed Snapshot API - Symbol List client library for .NET
FactSet’s Exchange DataFeed Snapshot API provides cost-effective access to real-time and delayed global exchange data. Proprietary technology normalizes over 300 global exchanges and 150+ data fields. Asset types integrated include equities, futures, options, warrants, fixed income, mutual funds, ETFs, indices, commodities, and FX rates. <p>Cutting-edge technology ensures reliability and provides scalability that allow applications to request multiple items at a time. To simplify client-side development an entire response can be placed in a matrix or table for effortless integration into internal and external applications. Using specified output formats (CSV, XML, JSON) receive all standard fields by default or customize the list based on specific needs.</p></p>Below are the current hosts:</p><p>Production: api.factset.com<p>Sandbox: api-sandbox.factset.com</p>
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- SDK version: 0.21.11
- Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen
Requirements
- .NET Standard >= 2.0
Installation
.NET CLI
dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList -v 0.21.11
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList -Version 0.21.11
Usage
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- Run the following:
[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
Example Code
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList.Api;
using FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList.Client;
using FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList.Model;
namespace Example
{
public static class GetDFSnapshotExample
{
public static async Task Main()
{
var config = new FactSet.SDK.ExchangeDataFeedSnapshotAPISymbolList.Client.Configuration();
// Examples for each supported authentication method are below,
// choose one that satisfies your use case.
/* (Preferred) OAuth 2.0: FactSetOAuth2 */
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-dotnet#authentication
// for more information on using the ConfidentialClient class
ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
config.OAuth2Client = confidentialClient;
/* Basic authentication: FactSetApiKey */
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// config.Username = "USERNAME-SERIAL";
// config.Password = "API-KEY";
var apiInstance = new SnapshotApi(config);
var ids = "ids_example"; // string | 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.<P>**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*.</p> (optional)
var oc = "oc_example"; // string | Option Chain, accepts one underlying symbol for which the option chain will be returned. **Required** if not using `ids`. <p>**Try it Out** - Only available for BABA-USA</p> (optional)
var fields = "fields_example"; // string | 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.<p>**Try it Out** - All fields available. Use either FID # or name. For `oc`, recommend to use BID_1,ASK_1,STRIKE_PRICE. (optional)
var sf = "sf_example"; // string | 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] * **VALUE_MINMAX** - Field value will be within specified interval. ex. - VALUE_MINMAX,BID_1,min,max * **VALUE_EQUALS** - Field value will equal specified value. ex. - VALUE_EQUALS,BID_1,value * **VALUE_NOT_EQUALS** - Field value will not equal specified value. ex. - VALUE_NOT_EQUALS,BID_1,value **Try it Out** - depends on fields used. Example - VALUE_MINMAX,STRIKE_PRICE,120,130 (optional)
var format = "XML"; // string | The format of the output file.<p>**Try it Out** - All formats available</p> (optional) (default to XML)
var serv = "FDS1"; // string | The Data Service that handles the request for the specified symbols. Available live services are - * **FDS1** -Production Data Service * **FDS_FUND** -Fundamental Data Service used for End-of-Day data. **Try it Out** - use FDS1 (optional)
var reqId = "reqId_example"; // string | 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.<p> **Try it Out** - any value can be passed through.</p> (optional)
try
{
// Request a snapshot of exchange data for a list of symbols.
DFSnapshotResponse result = apiInstance.GetDFSnapshot(ids, oc, fields, sf, format, serv, reqId);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling SnapshotApi.GetDFSnapshot: " + e.Message );
Console.WriteLine("Status Code: "+ e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
}
Using a Proxy
To use the API client with a HTTP proxy, setup a System.Net.WebProxy
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
Documentation for API Endpoints
All URIs are relative to https://api-sandbox.factset.com
Class | Method | HTTP request | Description |
---|---|---|---|
SnapshotApi | GetDFSnapshot | GET /DFSnapshot | Request a snapshot of exchange data for a list of symbols. |
SnapshotApi | PostDFSnapshot | POST /DFSnapshot | Snap exchange data. Use if URL lengh of 2,048 is exceeded. |
Documentation for Models
- Model.DFSnapshotResponse
- Model.ErrorResponse
- Model.ErrorResponseSubErrors
- Model.Fields
- Model.Specialfield
Documentation for Authorization
FactSetApiKey
- Type: HTTP basic authentication
FactSetOAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Contributing
Please refer to the contributing guide.
Copyright
Copyright 2022 FactSet Research Systems Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- FactSet.SDK.Utils (>= 1.0.0)
- JsonSubTypes (>= 1.8.0)
- Newtonsoft.Json (>= 13.0.3)
- Polly (>= 7.2.2)
- RestSharp (>= 106.15.0)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.21.11 | 90 | 7/11/2024 |
0.21.10 | 106 | 4/10/2024 |
0.21.9 | 267 | 10/25/2023 |
0.21.8 | 146 | 10/5/2023 |
0.21.7 | 159 | 8/30/2023 |
0.21.6 | 150 | 8/11/2023 |
0.21.5 | 146 | 6/6/2023 |
0.21.4 | 167 | 5/11/2023 |
0.21.3 | 232 | 3/1/2023 |
0.21.2 | 253 | 2/24/2023 |
0.21.1 | 394 | 8/31/2022 |
0.21.0 | 398 | 7/21/2022 |
0.20.0 | 398 | 5/24/2022 |
0.9.1 | 439 | 2/14/2022 |
0.9.0 | 429 | 2/2/2022 |
Refer to Changelog on GitHub source repository