@factset/sdk-factsetsearchanswers NPM

FactSet Search Answers client library for JavaScript

The FactSet Search Answers API provides answers to search queries, reflecting the data shown within FactSet Search Answers, and allowing you to easily add financial data to your widgets, lookups, bots, and assistants. The API understands a fixed amount of search terms and returns structured data from FactSet’s many data sources. Possible answers include Price of a Company, Top 10 Year-to-Date Gainers, Revenue per Passenger Mile, and many more.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

API version: 1.1.0
Package version: 1.1.0
Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

Requirements

Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-factsetsearchanswers@1.1.0

yarn

yarn add @factset/sdk-utils @factset/sdk-factsetsearchanswers@1.1.0

Usage

Generate authentication credentials.
Setup Node.js environment
1. Install and activate Node.js >=14. If you're using nvm:
```
nvm install 16
nvm use 16
```
2. (optional) Install yarn.
Install dependencies.
Run the following:

const { ApiClient, AnswersApi } = require('@factset/sdk-factsetsearchanswers');
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 AnswersApi();
const query = "query_example"; // String | Query for desired answer (e.g., \"fds price\")
const opts = {
  'includeThumbnail': false, // Boolean | Includes thumbnail of Adaptive Card in response
  'disableNoAnswerResponses': true, // Boolean | Disables no-result answer responses (no-results and answer without data)
  'theme': "'Light'" // String | Theme for desired answer (e.g., \"Light\", \"Dark\")
};

// Call api endpoint
apiInstance.searchForAdaptiveCardAnswer(query, opts).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

Class	Method	HTTP request	Description
factsetsearchanswers.AnswersApi	searchForAdaptiveCardAnswer	GET /search/answers/v1/adaptive-card	Fetch FactSet answer in Adaptive Card format
factsetsearchanswers.AnswersApi	searchForDataAnswer	GET /search/answers/v1/data	Fetch FactSet answer in data format

Documentation for Models

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

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.

FactSet API SDK

@factset/sdk-utils superagent

@everything-registry/sub-chunk-312

5 months ago

8 months ago

7 months ago

11 months ago