@factset/sdk-factsetpeople v1.0.4
FactSet People client library for JavaScript
The FactSet People API exposes FactSet data for individuals and their jobs.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.2.0
- Package version: 1.0.4
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/sdk-factsetpeople@1.0.4
yarn
yarn add @factset/sdk-utils @factset/sdk-factsetpeople@1.0.4
Usage
- Generate authentication credentials.
Setup Node.js environment
Install and activate Node.js >=14. If you're using nvm:
nvm install 16 nvm use 16
(optional) Install yarn.
- Run the following:
const { ApiClient, CompanyApi } = require('@factset/sdk-factsetpeople');
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 ids = ["AAPL-US","IBM-US"]; // [String] | The requested company identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs. <p>***ids limit** = 1000 per request*</p> *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.</p>*
// Call api endpoint
apiInstance.getCompanyCompensation(ids).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/content
Class | Method | HTTP request | Description |
---|---|---|---|
factsetpeople.CompanyApi | getCompanyCompensation | GET /factset-people/v1/company-compensation | Returns the compensation details of the people for the specified company identifier |
factsetpeople.CompanyApi | getCompanyCompensationForList | POST /factset-people/v1/company-compensation | Returns the compensation details for the people for the specified company identifier |
factsetpeople.CompanyApi | getCompanyPeople | GET /factset-people/v1/company-people | Returns the list of people for the specified company identifiers |
factsetpeople.CompanyApi | getCompanyPeopleForList | POST /factset-people/v1/company-people | Returns the list of people associated for a large list of company identitifers |
factsetpeople.CompanyApi | getCompanyPositions | GET /factset-people/v1/company-positions | Returns the list of people for the specified company identifiers and position |
factsetpeople.CompanyApi | getCompanyPositionsForList | POST /factset-people/v1/company-positions | Returns the list of people associated for a large list of company identitifers and position |
factsetpeople.CompanyApi | getCompanyStats | GET /factset-people/v1/company-stats | Returns statistics about top leadership of a company. |
factsetpeople.CompanyApi | getCompanyStatsForList | POST /factset-people/v1/company-stats | Returns statistics about top leadership of a company. |
factsetpeople.JobHistoryApi | getPeopleJobs | GET /factset-people/v1/jobs | Returns the Job history of the person. |
factsetpeople.JobHistoryApi | getPeopleJobsForList | POST /factset-people/v1/jobs | Returns the Job history for the large list of people. |
factsetpeople.ProfilesApi | getPeopleProfiles | GET /factset-people/v1/profiles | Return information about the person with the specified entity ID. |
factsetpeople.ProfilesApi | getPeopleProfilesForList | POST /factset-people/v1/profiles | Returns profile information for a large list of people. |
Documentation for Models
- factsetpeople.CompanyCompensation
- factsetpeople.CompanyCompensationRequest
- factsetpeople.CompanyCompensationResponse
- factsetpeople.CompanyPeople
- factsetpeople.CompanyPeopleRequest
- factsetpeople.CompanyPeopleResponse
- factsetpeople.CompanyPositions
- factsetpeople.CompanyPositionsRequest
- factsetpeople.CompanyPositionsResponse
- factsetpeople.CompanyStats
- factsetpeople.CompanyStatsRequest
- factsetpeople.CompanyStatsResponse
- factsetpeople.ErrorResponse
- factsetpeople.ErrorResponseSubErrors
- factsetpeople.Function
- factsetpeople.Job
- factsetpeople.Level
- factsetpeople.MbType
- factsetpeople.PeopleJobsRequest
- factsetpeople.PeopleJobsResponse
- factsetpeople.PeopleProfilesRequest
- factsetpeople.PeopleProfilesResponse
- factsetpeople.Position
- factsetpeople.Profile
- factsetpeople.Status
- factsetpeople.Type
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.