![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)
Company Logo client library for Python
![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)
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 Logo API provides access to logos of US, CA and EU listed companies. The logos could 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).
Logos are reviewed/updated twice a year.
The Logo API for Digital Portals 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 (see for example /notation/crossReference/getByFactSetMarketSymbol to retrieve an instrument id).
For direct access to price histories for charting, please refer to the
Time Series API for Digital Portals.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 3.0.0
- SDK version: 0.11.1
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit https://developer.factset.com/contact
Requirements
Installation
Poetry
poetry add fds.sdk.utils fds.sdk.CompanyLogo==0.11.1
pip
pip install fds.sdk.utils fds.sdk.CompanyLogo==0.11.1
Usage
- Generate authentication credentials.
- Setup Python environment.
-
Install and activate python 3.7+. If you're using pyenv:
pyenv install 3.9.7
pyenv shell 3.9.7
-
(optional) Install poetry.
- 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
from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.CompanyLogo
from fds.sdk.CompanyLogo.api import company_api
from fds.sdk.CompanyLogo.models import *
from dateutil.parser import parse as dateutil_parser
from pprint import pprint
configuration = fds.sdk.CompanyLogo.Configuration(
fds_oauth_client=ConfidentialClient('/path/to/app-config.json')
)
with fds.sdk.CompanyLogo.ApiClient(configuration) as api_client:
api_instance = company_api.CompanyApi(api_client)
identifier = "PQ6ZGC"
identifier_type = "idInstrument"
format = "rectangular"
attributes = [
"_attributes_example",
]
try:
api_response = api_instance.get_company_logo_get(identifier, identifier_type, format=format, attributes=attributes)
pprint(api_response)
except fds.sdk.CompanyLogo.ApiException as e:
print("Exception when calling CompanyApi->get_company_logo_get: %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/v3
Class | Method | HTTP request | Description |
---|
CompanyApi | get_company_logo_get | GET /company/logo/get | List of URLs of company logos. |
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 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.