@factset/sdk-companylogo v0.12.0
Company Logo client library for JavaScript
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 TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 3.0.0
- SDK version: 0.12.0
- Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen
For more information, please visit https://developer.factset.com/contact
Requirements
- Node.js >= 18
Installation
npm
npm install @factset/sdk-utils @factset/sdk-companylogo@0.12.0
yarn
yarn add @factset/sdk-utils @factset/sdk-companylogo@0.12.0
Usage
- Generate authentication credentials.
Setup Node.js environment
Install and activate Node.js >=18. If you're using nvm:
nvm install 18 nvm use 18
(optional) Install yarn.
- 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
const { ApiClient, CompanyApi } = require('@factset/sdk-companylogo');
const { ConfidentialClient } = require('@factset/sdk-utils');
const apiClient = ApiClient.instance;
// 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-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new 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
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';
const apiInstance = new CompanyApi();
const identifier = "identifier_example"; // String |
const identifierType = "identifierType_example"; // String |
const opts = {
'format': "'rectangular'", // String |
'attributes': ["null"] // [String] | Limit the attributes returned in the response to the specified set.
};
// Call api endpoint
apiInstance.getCompanyLogoGet(identifier, identifierType, opts).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
Using a Proxy
To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:
const { ApiClient } = require('@factset/sdk-companylogo');
const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:password@proxy.example.com:8080');
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/wealth/v3
Class | Method | HTTP request | Description |
---|---|---|---|
companylogo.CompanyApi | getCompanyLogoGet | GET /company/logo/get | List of URLs of company logos. |
Documentation for Models
- companylogo.CursorBasedPaginationOutputObject
- companylogo.CursorBasedPaginationOutputObjectWithoutTotal
- companylogo.ErrorMetaObject
- companylogo.InlineResponse200
- companylogo.InlineResponse200Data
- companylogo.InlineResponse200DataLarge
- companylogo.InlineResponse200DataMedium
- companylogo.InlineResponse200DataSmall
- companylogo.InlineResponse200DataVector
- companylogo.InlineResponse200Meta
- companylogo.OffsetBasedPaginationOutputObject
- companylogo.OffsetBasedPaginationOutputObjectWithoutTotal
- companylogo.PartialOutputObject
- companylogo.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.