FactSet.SDK.CompanyLogoAPIforDigitalPortals 0.10.11

Company Logo API for Digital Portals client library for .NET

Consume FactSet-collected company logos through an API that seamlessly integrates with company fundamentals and estimates data (listed equities data available via the stocks API), quotes, time series, and other Functional APIs.

This .NET package is automatically generated by the OpenAPI Generator project:

• API version: 2
• Package version: 0.10.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.CompanyLogoAPIforDigitalPortals -v 0.10.11

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.CompanyLogoAPIforDigitalPortals -Version 0.10.11

Usage

1. Generate authentication credentials.
2. Setup .NET Standard 2.0 compatible environment.
3. Install dependencies.
4. 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.CompanyLogoAPIforDigitalPortals.Api;
using FactSet.SDK.CompanyLogoAPIforDigitalPortals.Client;
using FactSet.SDK.CompanyLogoAPIforDigitalPortals.Model;

namespace Example
{
    public static class GetCompanyLogoGetExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.CompanyLogoAPIforDigitalPortals.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 CompanyApi(config);
            var identifier = "identifier_example";  // string | Identifier that resolves to a company. 
            var identifierType = "idInstrument";  // string | The type of the identifier.
            var format = "rectangular";  // string | Format of the logos. (optional)  (default to rectangular)
            var attributes = new List<string>(); // List<string> | Limit the attributes returned in the response to the specified set. (optional) 

            try
            {
                // List of URLs of company logos.
                InlineResponse200 result = apiInstance.GetCompanyLogoGet(identifier, identifierType, format, attributes);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling CompanyApi.GetCompanyLogoGet: " + 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 http://api.factset.com/wealth/v1

Documentation for Models

• Model.CursorBasedPaginationOutputObject
• Model.CursorBasedPaginationOutputObjectWithoutTotal
• Model.ErrorMetaObject
• Model.InlineResponse200
• Model.InlineResponse200Data
• Model.InlineResponse200DataLarge
• Model.InlineResponse200DataMedium
• Model.InlineResponse200DataSmall
• Model.InlineResponse200DataVector
• Model.InlineResponse200Meta
• Model.OffsetBasedPaginationOutputObject
• Model.OffsetBasedPaginationOutputObjectWithoutTotal
• Model.PartialOutputObject
• Model.StatusObject

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.