Skip to main content

Company Logo client library for Python

Project description

FactSet

Company Logo client library for Python

API Version PyPi Apache-2 license

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 Digital APIs.

The Company Logo API provides access to logos for a global universe of listed companies. The logos can be accessed by using national and international identifiers like ISIN, CUSIP, WKN, Valor, etc. and are a nice feature for comprehensive visualizations of equities on overview pages (factsheets).

Logo collection and maintenance takes into account IPOs, M&A notifications, and further consistency check mechanisms.

The Company Logo API seamlessly integrates with the Stocks API for equities and estimates data and the Quotes API, allowing access to detailed price and performance information of listings. The Quotes API also supports basic security identifier cross-reference. For direct access to price histories for charting, please refer to the Real-Time Time Series API.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 5.0.0
  • SDK version: 0.40.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

  • Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.CompanyLogo==0.40.0

pip

pip install fds.sdk.utils fds.sdk.CompanyLogo==0.40.0

Usage

  1. Generate authentication credentials.
  2. Setup Python environment.
    1. Install and activate python 3.7+. If you're using pyenv:

      pyenv install 3.9.7
      pyenv shell 3.9.7
      
    2. (optional) Install poetry.

  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

from fds.sdk.utils.authentication import ConfidentialClient

import fds.sdk.CompanyLogo
from fds.sdk.CompanyLogo.api import company_logos_api
from fds.sdk.CompanyLogo.models import *
from dateutil.parser import parse as dateutil_parser
from pprint import pprint

# See configuration.py for a list of all supported configuration parameters.

# 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-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.CompanyLogo.Configuration(
    fds_oauth_client=ConfidentialClient('/path/to/app-config.json')
)

# Basic authentication: FactSetApiKey
# See https://github.com/FactSet/enterprise-sdk#api-key
# for information how to create an API key
# configuration = fds.sdk.CompanyLogo.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.CompanyLogo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = company_logos_api.CompanyLogosApi(api_client)
    post_company_logo_request = PostCompanyLogoRequest(
        data=PostCompanyLogoRequestData(
            identifier=PostCompanyLogoRequestDataIdentifier(
                values=["FDS-US"],
                type="tickerRegion",
            ),
            format="rectangular",
            size=PostCompanyLogoRequestDataSize(
                predefined=[
                    "small",
                ],
                custom=PostCompanyLogoRequestDataSizeCustom(
                    width=10,
                    height=10,
                ),
            ),
            mime_type="image/png",
        ),
        meta=PostCompanyLogoRequestMeta(
            attributes=AttributesMember([]),
        ),
    ) # PostCompanyLogoRequest | Request Body (optional)

    try:
        # Retrieves logos for one or more publicly traded companies.
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.post_company_logo(post_company_logo_request=post_company_logo_request)

        pprint(api_response)
    except fds.sdk.CompanyLogo.ApiException as e:
        print("Exception when calling CompanyLogosApi->post_company_logo: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Retrieves logos for one or more publicly traded companies.
    #     api_response, http_status_code, response_headers = api_instance.post_company_logo_with_http_info(post_company_logo_request=post_company_logo_request)


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.CompanyLogo.ApiException as e:
    #     print("Exception when calling CompanyLogosApi->post_company_logo: %s\n" % e)

    # # Get response asynchronous
    # try:
    #     # Retrieves logos for one or more publicly traded companies.
    #     async_result = api_instance.post_company_logo_async(post_company_logo_request=post_company_logo_request)
    #     api_response = async_result.get()


    #     pprint(api_response)
    # except fds.sdk.CompanyLogo.ApiException as e:
    #     print("Exception when calling CompanyLogosApi->post_company_logo: %s\n" % e)

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Retrieves logos for one or more publicly traded companies.
    #     async_result = api_instance.post_company_logo_with_http_info_async(post_company_logo_request=post_company_logo_request)
    #     api_response, http_status_code, response_headers = async_result.get()


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.CompanyLogo.ApiException as e:
    #     print("Exception when calling CompanyLogosApi->post_company_logo: %s\n" % e)

Using Pandas

To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.

import pandas as pd

response_dict = api_response.to_dict()['data']

simple_json_response = pd.DataFrame(response_dict)
nested_json_response = pd.json_normalize(response_dict)

Debugging

The SDK uses the standard library logging module.

Setting debug to True on an instance of the Configuration class sets the log-level of related packages to DEBUG and enables additional logging in Pythons HTTP Client.

Note: This prints out sensitive information (e.g. the full request and response). Use with care.

import logging
import fds.sdk.CompanyLogo

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.CompanyLogo.Configuration(...)
configuration.debug = True

Configure a Proxy

You can pass proxy settings to the Configuration class:

  • proxy: The URL of the proxy to use.
  • proxy_headers: a dictionary to pass additional headers to the proxy (e.g. Proxy-Authorization).
import fds.sdk.CompanyLogo

configuration = fds.sdk.CompanyLogo.Configuration(
    # ...
    proxy="http://secret:password@localhost:5050",
    proxy_headers={
        "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
    }
)

Custom SSL Certificate

TLS/SSL certificate verification can be configured with the following Configuration parameters:

  • ssl_ca_cert: a path to the certificate to use for verification in PEM format.
  • verify_ssl: setting this to False disables the verification of certificates. Disabling the verification is not recommended, but it might be useful during local development or testing.
import fds.sdk.CompanyLogo

configuration = fds.sdk.CompanyLogo.Configuration(
    # ...
    ssl_ca_cert='/path/to/ca.pem'
)

Request Retries

In case the request retry behaviour should be customized, it is possible to pass a urllib3.Retry object to the retry property of the Configuration.

from urllib3 import Retry
import fds.sdk.CompanyLogo

configuration = fds.sdk.CompanyLogo.Configuration(
    # ...
)

configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/wealth/v5

Class Method HTTP request Description
CompanyLogosApi post_company_logo POST /company/logo Retrieves logos for one or more publicly traded companies.

Documentation For Models

Documentation For Authorization

FactSetApiKey

  • Type: HTTP basic authentication

FactSetOAuth2

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in fds.sdk.CompanyLogo.apis and fds.sdk.CompanyLogo.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from fds.sdk.CompanyLogo.api.default_api import DefaultApi
  • from fds.sdk.CompanyLogo.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import fds.sdk.CompanyLogo
from fds.sdk.CompanyLogo.apis import *
from fds.sdk.CompanyLogo.models import *

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2026 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fds_sdk_companylogo-0.40.0.tar.gz (57.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fds_sdk_companylogo-0.40.0-py3-none-any.whl (103.6 kB view details)

Uploaded Python 3

File details

Details for the file fds_sdk_companylogo-0.40.0.tar.gz.

File metadata

  • Download URL: fds_sdk_companylogo-0.40.0.tar.gz
  • Upload date:
  • Size: 57.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for fds_sdk_companylogo-0.40.0.tar.gz
Algorithm Hash digest
SHA256 7ce091013cd5a18f7bf906fd0dabefde1ae2381dbd7aab4aaa83b642ec0b94d3
MD5 322b2f91e9c8dd1fb68b699e1f295229
BLAKE2b-256 0286072d3f08c51d30a06da2c48a9ea02ade784c9fe6aa487da9822003aa3624

See more details on using hashes here.

File details

Details for the file fds_sdk_companylogo-0.40.0-py3-none-any.whl.

File metadata

File hashes

Hashes for fds_sdk_companylogo-0.40.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae5c632cfb9479f090a90adb74395d41c933b939289002bf2ca5981a109da082
MD5 f9e363ad8f3f1d4ac5fcf4774b2d2194
BLAKE2b-256 7a57d7e884c3c390cf026beca44945f0be4851bfc3fa79a591b2a0d08491065f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page