@factset/sdk-factsetcontentapibatch v0.21.4
FactSet Content API Batch client library for JavaScript
FactSet Content APIs - Batching Endpoint
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 0.21.4
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit http://www.factset.com/api
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/sdk-factsetcontentapibatch@0.21.4
yarn
yarn add @factset/sdk-utils @factset/sdk-factsetcontentapibatch@0.21.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, BatchProcessingApi } = require('@factset/sdk-factsetcontentapibatch');
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 BatchProcessingApi();
const id = "id_example"; // String | Batch Request identifier.
// Call api endpoint
apiInstance.getBatchData(id).then(
data => {
// data is a responsewrapper: GetBatchDataResponseWrapper
switch (data.statusCode) {
case 200:
// BatchDataResponse
console.log(data.getResponse200());
break;
case 202:
// BatchStatusResponse
console.log(data.getResponse202());
break;
}
},
error => {
console.error(error);
},
);
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/content
Class | Method | HTTP request | Description |
---|---|---|---|
factsetcontentapibatch.BatchProcessingApi | getBatchData | GET /batch/v1/result | Returns the response for a Batch Request |
factsetcontentapibatch.BatchProcessingApi | getBatchDataWithPost | POST /batch/v1/result | Returns the response for a Batch Request |
factsetcontentapibatch.BatchProcessingApi | getBatchStatus | GET /batch/v1/status | Returns the status for a Batch Request |
factsetcontentapibatch.BatchProcessingApi | getBatchStatusWithPost | POST /batch/v1/status | Returns the status for a Batch Request |
Documentation for Models
- factsetcontentapibatch.BatchDataRequest
- factsetcontentapibatch.BatchDataResponse
- factsetcontentapibatch.BatchStatus
- factsetcontentapibatch.BatchStatusRequest
- factsetcontentapibatch.BatchStatusResponse
- factsetcontentapibatch.ErrorResponse
- factsetcontentapibatch.ErrorResponseSubErrors
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.